interface WalkOptions

Options for walk.

Properties

optional
maxDepth: number

Maximum recursion depth. 0 means only immediate children of root.

optional
includeFiles: boolean

Whether to include regular files in results.

optional
includeDirs: boolean

Whether to include directories in results.

optional
match: RegExp[]

Only yield entries whose path (relative to root) matches at least one pattern. When omitted all entries are included.

optional
skip: RegExp[]

Skip entries whose path (relative to root) matches any of these patterns.

Usage

import { type WalkOptions } from ".";