Function lsFiles

Lists files in the specified directory path, filtering by a regular expression pattern.

The returned entries are configurable using the additional options, such as listing recursively to subdirectories, and filter specific file and/or directory names using a regular expression.

The additional options can be an object or a regex pattern to specify only the match field. If passed as a RegExp object, the rest options (except the match field) for reading the directory will uses default options.

If the options argument not specified (or undefined), then it uses the default value:

[LsOptions]: {
  encoding: 'utf8',
  recursive: false,
  match: /.+/,
  exclude: undefined
}
Copy

History

1.0.0

As of version 1.0.0, this function now accepts file URL paths. This can be either a string URL path or a URL object, and it must follow the 'file:' protocol. An URIError will be thrown if the specified file URL path has invalid file URL syntax or is used with unsupported protocols.

0.1.0

Added in version 0.1.0.

Throws

Error - If there is an error occurred while reading a directory.

Throws

URIError - If the given URL path contains invalid file URL scheme or using unsupported protocols.

Example

// List all JavaScript files in current directory recursively,
// but excluding files from 'tests' directory
lsFiles('.', {
  recursive: true,
  match: /.+\.[cm]*js$/,
  exclude: /[\/\\]\btests\b[\/\\]/
}).then((files) => console.log(files));
Copy

Since

0.1.0

See

• ls
• lsDirs
• fs.readdir