diff options
Diffstat (limited to 'vanilla/node_modules/fdir/README.md')
| -rw-r--r-- | vanilla/node_modules/fdir/README.md | 91 |
1 files changed, 0 insertions, 91 deletions
diff --git a/vanilla/node_modules/fdir/README.md b/vanilla/node_modules/fdir/README.md deleted file mode 100644 index 5c70530..0000000 --- a/vanilla/node_modules/fdir/README.md +++ /dev/null @@ -1,91 +0,0 @@ -<p align="center"> -<img src="https://github.com/thecodrr/fdir/raw/master/assets/fdir.gif" width="75%"/> - -<h1 align="center">The Fastest Directory Crawler & Globber for NodeJS</h1> -<p align="center"> - <a href="https://www.npmjs.com/package/fdir"><img src="https://img.shields.io/npm/v/fdir?style=for-the-badge"/></a> - <a href="https://www.npmjs.com/package/fdir"><img src="https://img.shields.io/npm/dw/fdir?style=for-the-badge"/></a> - <a href="https://codeclimate.com/github/thecodrr/fdir/maintainability"><img src="https://img.shields.io/codeclimate/maintainability-percentage/thecodrr/fdir?style=for-the-badge"/></a> - <a href="https://coveralls.io/github/thecodrr/fdir?branch=master"><img src="https://img.shields.io/coveralls/github/thecodrr/fdir?style=for-the-badge"/></a> - <a href="https://www.npmjs.com/package/fdir"><img src="https://img.shields.io/bundlephobia/minzip/fdir?style=for-the-badge"/></a> - <a href="https://www.producthunt.com/posts/fdir-every-millisecond-matters"><img src="https://img.shields.io/badge/ProductHunt-Upvote-red?style=for-the-badge&logo=product-hunt"/></a> - <a href="https://dev.to/thecodrr/how-i-wrote-the-fastest-directory-crawler-ever-3p9c"><img src="https://img.shields.io/badge/dev.to-Read%20Blog-black?style=for-the-badge&logo=dev.to"/></a> - <a href="./LICENSE"><img src="https://img.shields.io/github/license/thecodrr/fdir?style=for-the-badge"/></a> -</p> -</p> - -⚡ **The Fastest:** Nothing similar (in the NodeJS world) beats `fdir` in speed. It can easily crawl a directory containing **1 million files in < 1 second.** - -💡 **Stupidly Easy:** `fdir` uses expressive Builder pattern to build the crawler increasing code readability. - -🤖 **Zero Dependencies\*:** `fdir` only uses NodeJS `fs` & `path` modules. - -🕺 **Astonishingly Small:** < 2KB in size gzipped & minified. - -🖮 **Hackable:** Extending `fdir` is extremely simple now that the new Builder API is here. Feel free to experiment around. - -_\* `picomatch` must be installed manually by the user to support globbing._ - -## 🚄 Quickstart - -### Installation - -You can install using `npm`: - -```sh -$ npm i fdir -``` - -or Yarn: - -```sh -$ yarn add fdir -``` - -### Usage - -```ts -import { fdir } from "fdir"; - -// create the builder -const api = new fdir().withFullPaths().crawl("path/to/dir"); - -// get all files in a directory synchronously -const files = api.sync(); - -// or asynchronously -api.withPromise().then((files) => { - // do something with the result here. -}); -``` - -## Documentation: - -Documentation for all methods is available [here](/documentation.md). - -## 📊 Benchmarks: - -Please check the benchmark against the latest version [here](/BENCHMARKS.md). - -## 🙏Used by: - -`fdir` is downloaded over 200k+ times a week by projects around the world. Here's a list of some notable projects using `fdir` in production: - -> Note: if you think your project should be here, feel free to open an issue. Notable is anything with a considerable amount of GitHub stars. - -1. [rollup/plugins](https://github.com/rollup/plugins) -2. [SuperchupuDev/tinyglobby](https://github.com/SuperchupuDev/tinyglobby) -3. [pulumi/pulumi](https://github.com/pulumi/pulumi) -4. [dotenvx/dotenvx](https://github.com/dotenvx/dotenvx) -5. [mdn/yari](https://github.com/mdn/yari) -6. [streetwriters/notesnook](https://github.com/streetwriters/notesnook) -7. [imba/imba](https://github.com/imba/imba) -8. [moroshko/react-scanner](https://github.com/moroshko/react-scanner) -9. [netlify/build](https://github.com/netlify/build) -10. [yassinedoghri/astro-i18next](https://github.com/yassinedoghri/astro-i18next) -11. [selfrefactor/rambda](https://github.com/selfrefactor/rambda) -12. [whyboris/Video-Hub-App](https://github.com/whyboris/Video-Hub-App) - -## 🦮 LICENSE - -Copyright © 2024 Abdullah Atta under MIT. [Read full text here.](https://github.com/thecodrr/fdir/raw/master/LICENSE) |
