Skip to content

Latest commit

 

History

History
59 lines (42 loc) · 1.8 KB

README.md

File metadata and controls

59 lines (42 loc) · 1.8 KB

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

$ npm i @a73/get-all-files-ts

Usage

Please visit documentation at get-all-files-ts github pages to see examples of its use.

Documentation

This library is using typedoc. 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.

License

MIT © Rodrigo Erades