FilePaths

FilePaths is a Generator function listing paths of files in a given list of directories and satisfying a given condition.

const {FilePaths} = require ('fs-iterators')

for (const path of FilePaths ({
  dir: ['/home/my_project/views']
  filter: (fileName, directoryPath, filePath) => /^vw_/.test (fileName)
})) console.log ({path})

Options

dir

An iterable of directories' full paths to scan (linearly, without subdirectories).

Normally, a DirList instance is presumed here (to process hierarchy), but a raw Array and any other iterable object may be used.

filter

typeof filter	Result
undefined	All files
string	Files which local name (with extension) equals to filter
function	Files for which filter (localName, directoryPath, fullPath) returns a truthy value

In the latter case, the filter function is called with the following arguments:

Name	Type	Description
fileName	String	The local name of the file.
directoryPath	String	The path to containing directory; one of dir values
filePath	String	directoryPath + path.sep + fileName

If the result is truthy, the filePath value is yielded.