Function filterScanDir

for async version only - maximum directories reading entries or metadata concurrently. Default: 50. Ancestors waiting for child directories do not consume a slot.

• Set this to 0 or 1 to disable concurrent mode

NOTE: setting this to a very large number, or Infinity, could potentially increase performance very significantly, however, there is a dimishing return and more memory usage, so the default is already fairly good.

current working directory to start scanning

callback to filter files.

callback to filter directories.

array or string of extensions to include only, apply after ignoreExt

use fs.lstat to get stat of each file, instead of readir's withFileTypes option.

• Default: true - for significant performance improvement, set this to false

parse ancestor repository and nested .gitignore rules; disabled when omitted

directory basenames to skip at every depth, before reading metadata or children

array or string of extensions to ignore. ext must include ., ie: ".js"

include directories in result

include symlinks in result. When includeDir is false, all symlinks are skipped unless this is true, links to files as well as links to directories. When includeDir is true, this option has no effect and symlinks go through the normal filters. Symlinks are never followed.

zero base max level of directories to recurse into. Default: Infinity

path separator to use to join entries in output paths. Filesystem calls always use /.

• Default: path.posix.sep
• If you didn't specify this, then cwd is automatically converted to use /.

synchronous entry filter before lstat; returning false also prunes directories. Requires fullStat to be true (the default). Throws when fullStat is false.

prefix to add to the paths to scan. It's applied after cwd.

• The prefix will be in the resulting paths. Useful if you want to scan a dir further down from cwd but you don't want to prepend CWD to the resulting paths.

prepend CWD to paths returned

set to true to throw errors instead of ignoring them

sort files from each dir

for async version only - maximum directories reading entries or metadata concurrently. Default: 50. Ancestors waiting for child directories do not consume a slot.

• Set this to 0 or 1 to disable concurrent mode

NOTE: setting this to a very large number, or Infinity, could potentially increase performance very significantly, however, there is a dimishing return and more memory usage, so the default is already fairly good.

current working directory to start scanning

callback to filter files.

callback to filter directories.

array or string of extensions to include only, apply after ignoreExt

use fs.lstat to get stat of each file, instead of readir's withFileTypes option.

• Default: true - for significant performance improvement, set this to false

parse ancestor repository and nested .gitignore rules; disabled when omitted

directory basenames to skip at every depth, before reading metadata or children

array or string of extensions to ignore. ext must include ., ie: ".js"

include directories in result

include symlinks in result. When includeDir is false, all symlinks are skipped unless this is true, links to files as well as links to directories. When includeDir is true, this option has no effect and symlinks go through the normal filters. Symlinks are never followed.

zero base max level of directories to recurse into. Default: Infinity

path separator to use to join entries in output paths. Filesystem calls always use /.

• Default: path.posix.sep
• If you didn't specify this, then cwd is automatically converted to use /.

synchronous entry filter before lstat; returning false also prunes directories. Requires fullStat to be true (the default). Throws when fullStat is false.

prefix to add to the paths to scan. It's applied after cwd.

• The prefix will be in the resulting paths. Useful if you want to scan a dir further down from cwd but you don't want to prepend CWD to the resulting paths.

prepend CWD to paths returned

set to true to throw errors instead of ignoring them

sort files from each dir