Interface FindOptions

Hierarchy

Properties

append? cwd? depth? exclude? findType? limit? noCase? overwrite?

Properties

Optional append

append?: boolean

Append to the file instead of overwriting it when it already exists.

Optional cwd

cwd?: string | string[]

Single or multiple Working directories to use when searching. If not specified the current working directory is used.

Optional depth

depth?: number

Maximum depth to search in the directory structure.

Optional exclude

exclude?: GlobPatterns

Glob patterns of natches to exclude from the search

Optional findType

findType?: FindType | "directory" | "file"

Type of items to find, either files or directories or both. By default only files are returned.

Optional limit

limit?: number

Maximum number of results to return after which the search is stopped.

Optional noCase

noCase?: boolean

When true the search is case insensitive, otherwise case sensitive. Defaults to case insensitive matching.

Optional overwrite

overwrite?: boolean

Overwrite the file when it already exists. If set to false, an exception is thrown when the file already exists. Otherwise the file is overwritten (default)

Default

true

Settings

Member Visibility

Theme

On This Page