https://github.com/fredlackey/find-file-types
Locate file types in folder path.
https://github.com/fredlackey/find-file-types
Last synced: 10 months ago
JSON representation
Locate file types in folder path.
- Host: GitHub
- URL: https://github.com/fredlackey/find-file-types
- Owner: FredLackey
- License: apache-2.0
- Created: 2020-06-03T20:10:26.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-04-27T21:38:34.000Z (over 2 years ago)
- Last Synced: 2025-02-27T01:33:49.548Z (10 months ago)
- Language: JavaScript
- Size: 96.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README-ALT.md
- License: LICENSE
Awesome Lists containing this project
README
# Find File Types for NodeJS
> The following document applies to the programaticc usage of `find-file-types`. For use from the command line, please see the [main README located here](README.md).
## Purpose
Find (and optionally count) all unique file extensions within a folder or folder structure.
> More info on _why_ I created this is on my blog: [https://fredlackey.com](https://www.fredlackey.com)
## Installation
```
npm i find-file-types
```
## Usage
```
const fft = require('find-file-types');
const results = fft.processOptions({
source : /Users/Volumes/MPHD01/Multimedia
});
```
### Options
| Name | Description | Type | Default |
|-----------------|------------------------------------|-----------------|---------|
| `source` | Source Directory | `string (path)` | |
| `recursive` | Locate files recursively | `boolean` | `true` |
| `caseSensitive` | Match extension | `boolean` | `false` |
| `count` | Return count with list | `boolean` | `false` |
| `allowBlank` | Include files without an extension | `boolean` | `true` |
| `limit` | Number of files to process | `number` | |
### Contact
Please feel free to contact me directly with any questions, comments, or enhancement requests:
**Fred Lackey**
**[fred.lackey@gmail.com](mailto://fred.lackey@gmail.com)**
**[http://fredlackey.com](http://www.fredlackey.com)**