Interface WalkOptions

Options for walk and walkSync.

interface WalkOptions {
    canonicalize?: boolean;
    exts?: string[];
    followSymlinks?: boolean;
    includeDirs?: boolean;
    includeFiles?: boolean;
    includeSymlinks?: boolean;
    match?: RegExp[];
    maxDepth?: number;
    skip?: RegExp[];
}

Properties

canonicalize? exts? followSymlinks? includeDirs? includeFiles? includeSymlinks? match? maxDepth? skip?

Properties

Optionalcanonicalize

canonicalize?: boolean

Indicates whether the followed symlink's path should be canonicalized. This option works only if followSymlinks is not false.

Default

{true}

Optionalexts

exts?: string[]

List of file extensions used to filter entries. If specified, entries without the file extension specified by this option are excluded.

File extensions with or without a leading period are accepted.

Default

{[]}

OptionalfollowSymlinks

followSymlinks?: boolean

Indicates whether symlinks should be resolved or not.

Default

{false}

OptionalincludeDirs

includeDirs?: boolean

Indicates whether directory entries should be included or not.

Default

{true}

OptionalincludeFiles

includeFiles?: boolean

Indicates whether file entries should be included or not.

Default

{true}

OptionalincludeSymlinks

includeSymlinks?: boolean

Indicates whether symlink entries should be included or not. This option is meaningful only if followSymlinks is set to false.

Default

{true}

Optionalmatch

match?: RegExp[]

List of regular expression patterns used to filter entries. If specified, entries that do not match the patterns specified by this option are excluded.

OptionalmaxDepth

maxDepth?: number

The maximum depth of the file tree to be walked recursively.

Default

{Infinity}

Optionalskip

skip?: RegExp[]

List of regular expression patterns used to filter entries. If specified, entries matching the patterns specified by this option are excluded.

Settings

Member Visibility

On This Page

Properties