WalkOptions | /fs/mod.ts | std@0.220.1

interface WalkOptions

import { type WalkOptions } from "https://deno.land/std@0.220.1/fs/mod.ts";

Options for walk and walkSync.

Properties

optional

maxDepth: number = Infinity

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

optional

includeFiles: boolean = true

Indicates whether file entries should be included or not.

optional

includeDirs: boolean = true

Indicates whether directory entries should be included or not.

optional

includeSymlinks: boolean = true

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

optional

followSymlinks: boolean = false

Indicates whether symlinks should be resolved or not.

optional

canonicalize: boolean = true

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

optional

exts: string[] = undefined

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

optional

match: RegExp[] = undefined

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

optional

skip: RegExp[] = undefined

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