From c0845254b3b2369e10b9f8c78b104c43ea845c37 Mon Sep 17 00:00:00 2001 From: Karl Horky Date: Thu, 29 Aug 2024 19:43:06 +0200 Subject: [PATCH] Remove fileFilter "array of strings" from readme Seems like it was removed in https://github.com/paulmillr/readdirp/commit/703dee9f823f74fd990b503df52652f397759b1f --- README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/README.md b/README.md index d9fce0f..21437d0 100644 --- a/README.md +++ b/README.md @@ -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.