https://github.com/area73/get-all-files-ts
⚡ A blazing fast recursive directory crawler with lazy sync and async iterator support, write in typeScript.
https://github.com/area73/get-all-files-ts
async-iterators files javascript nodejs path recursive typescript
Last synced: 12 months ago
JSON representation
⚡ A blazing fast recursive directory crawler with lazy sync and async iterator support, write in typeScript.
- Host: GitHub
- URL: https://github.com/area73/get-all-files-ts
- Owner: area73
- License: other
- Created: 2022-01-15T11:01:58.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2025-06-09T15:51:45.000Z (12 months ago)
- Last Synced: 2025-06-09T16:42:14.600Z (12 months ago)
- Topics: async-iterators, files, javascript, nodejs, path, recursive, typescript
- Language: TypeScript
- Homepage: http://npm.im/@a73/get-all-files-ts
- Size: 119 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: license
Awesome Lists containing this project
README
get-all-files-ts
A blazing fast recursive directory crawler with lazy sync and async iterator support made in TypeScript.
**Forked from https://github.com/TomerAberbach/get-all-files**
### This version differs from original version in:
* files are now typeScript native*.ts
* more types added.
* added XO as linter.
* removed Ava testing framework in favor of jest as testing framework.
* Added new tests.
* Added jsDoc on private and public functions.
* Added extra param in options `excludedDirs?: string[]`:
* An array of excluded dirs. Similar to `isExcludedDir` but without the hassle fo creating a
predicate. Just give it a list of dirs to be excluded.
## Install
```sh
$ npm i @a73/get-all-files-ts
```
## Usage
Please visit documentation at [`get-all-files-ts` github pages](https://area73.github.io/get-all-files-ts/) to see examples of its use.
## Documentation
This library is using [typedoc](https://typedoc.org/).
A documentation generator for TypeScript projects, similar to jsDoc but for TypeScript files.
You can find it on `/docs` folder or just visit documentation online at https://area73.github.io/get-all-files-ts/
## Contributing
Stars are always welcome!
For bugs and feature requests,
[please create an issue](https://github.com/area73/get-all-files-ts/issues/new).
## License
[MIT](https://github.com/area73/get-all-files-ts/blob/main/license) ©
[Rodrigo Erades](https://github.com/area73)