Interface IWalkDirectoryOptions

Hierarchy

  • Omit<WalkOptions, "filter" | "no_return">
    • IWalkDirectoryOptions

Properties

filter? find-links? follow-symlinks? fs? max-depth? no-recurse? return-object? sync? track-inodes?

Properties

Optional filter

filter?: ((fullpath, stat) => boolean)

Type declaration

    • (fullpath, stat): boolean

    • Parameters

      • fullpath: string
      • stat: Stats

      Returns boolean

Optional find-links

find-links?: boolean

default True. if false this will use stat insteqad of lstat and not find links at all.

Optional follow-symlinks

follow-symlinks?: boolean

follow symlinks. default FALSE

Optional fs

fs?: any

provide an alternate implementation of fs like graceful-fs

Optional max-depth

max-depth?: number

only travel to max depth. emits an error if hit.

Optional no-recurse

no-recurse?: boolean

only go one level deep. convenience param.

Optional return-object

return-object?: boolean

return an object of {path:stat} instead of just the resolved path names

Optional sync

sync?: boolean

make this syncronous. the same as calling walkdir.sync

Optional track-inodes

track-inodes?: boolean

on filesystems where inodes are not unique like windows (or perhaps hardlinks) some files may not be emitted due to inode collision. turning off this behavior may be required but at the same time may lead to hitting max_depth via link loop.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc