@a73/get-all-files-ts 中文文档教程
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.
Install
$ npm i @a73/get-all-files-ts
Usage
请访问 get-all-files-ts
github pages 的文档以请参阅其使用示例。
Documentation
该库使用 typedoc。 用于 TypeScript 项目的文档生成器,类似于 jsDoc 但用于 TypeScript 文件。
您可以在 /docs
文件夹中找到它,或者只需访问 https://area73.github.io/get-all-files-ts/
Contributing
即可在线访问文档。
对于错误和功能请求, 请创建一个问题。
License
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.
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.