https://github.com/jchip/filter-scan-dir
Recursively scan and filter directory for a flat array of files
https://github.com/jchip/filter-scan-dir
Last synced: over 1 year ago
JSON representation
Recursively scan and filter directory for a flat array of files
- Host: GitHub
- URL: https://github.com/jchip/filter-scan-dir
- Owner: jchip
- License: apache-2.0
- Created: 2019-02-26T17:22:31.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2022-02-18T09:16:31.000Z (over 4 years ago)
- Last Synced: 2025-02-23T08:21:19.208Z (over 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 187 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# filter-scan-dir
[![License][license-image]][license-url]
[![build][build-image]][build-url]
[![coverage][coverage-image]][coverage-url]
[![Downloads][downloads-image]][downloads-url]
[![npm badge][npm-badge-png]][package-url]
Recursively scan and filter directory for a flat array of files.
- Supports super fast concurrent mode in async version.
- **[API Docs]**
- **[Github]**
# Install
```bash
npm install --save filter-scan-dir
```
# Usage
```ts
import { filterScanDir, filterScanDirSync } from "filter-scan-dir";
// sync
console.log(filterScanDirSync({ cwd: "test" }));
// async
console.log(await filterScanDir({ cwd: "test" }));
```
- **[API Docs]**
# License
Licensed under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0)
[npm-version-svg]: https://badge.fury.io/js/filter-scan-dir.svg
[package-url]: https://npmjs.com/package/filter-scan-dir
[deps-svg]: https://david-dm.org/filter-scan-dir.svg
[deps-url]: https://david-dm.org/filter-scan-dir
[dev-deps-svg]: https://david-dm.org/filter-scan-dir/dev-status.svg
[dev-deps-url]: https://david-dm.org/filter-scan-dir#info=devDependencies
[license-image]: https://img.shields.io/npm/l/filter-scan-dir.svg
[license-url]: LICENSE
[build-image]: https://github.com/jchip/filter-scan-dir/actions/workflows/node.js.yml/badge.svg
[build-url]: https://github.com/jchip/filter-scan-dir/actions/workflows/node.js.yml
[coverage-image]: https://coveralls.io/repos/github/jchip/filter-scan-dir/badge.svg?branch=main
[coverage-url]: https://coveralls.io/github/jchip/filter-scan-dir?branch=main
[downloads-image]: https://img.shields.io/npm/dm/filter-scan-dir.svg
[downloads-url]: https://npm-stat.com/charts.html?package=filter-scan-dir
[npm-badge-png]: https://nodei.co/npm/filter-scan-dir.png?downloads=true&stars=true
[api docs]: https://jchip.github.io/filter-scan-dir/modules.html#filterScanDir
[github]: https://github.com/jchip/filter-scan-dir