Skip to content

Commit

Permalink
Merge pull request #198 from karlhorky/patch-1
Browse files Browse the repository at this point in the history
Remove fileFilter "array of strings" from readme
  • Loading branch information
paulmillr authored Aug 29, 2024
2 parents c6dec75 + c084525 commit c62879e
Showing 1 changed file with 1 addition and 3 deletions.
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,10 +68,8 @@ First argument is awalys `root`, path in which to start reading and recursing in

### options

- `fileFilter`: filter to include or exclude files. A `Function`, string or Array of strings.
- `fileFilter`: filter to include or exclude files
- **Function**: a function that takes an entry info as a parameter and returns true to include or false to exclude the entry
- **string**: a string (e.g., `index.js`)
- **Array of strings**:
- `directoryFilter`: filter to include/exclude directories found and to recurse into. Directories that do not pass a filter will not be recursed into.
- `depth: 5`: depth at which to stop recursing even if more subdirectories are found
- `type: 'files'`: determines if data events on the stream should be emitted for `'files'` (default), `'directories'`, `'files_directories'`, or `'all'`. Setting to `'all'` will also include entries for other types of file descriptors like character devices, unix sockets and named pipes.
Expand Down

0 comments on commit c62879e

Please sign in to comment.