path-scurry

Ugh, yet another file traversal thing on npm?

Well what is it you wanted?

PERFORMANCE

USAGE

API

Interface `PathScurryOpts`

Interface `WalkOptions`

Class `PathScurry`

`async pw.walk(entry?: string | Path | WalkOptions, opts?: WalkOptions)`

`pw.walkSync(entry?: string | Path | WalkOptions, opts?: WalkOptions)`

`pw.iterate(entry?: string | Path | WalkOptions, opts?: WalkOptions)`

`pw.iterateSync(entry?: string | Path | WalkOptions, opts?: WalkOptions)`

`pw.stream(entry?: string | Path | WalkOptions, opts?: WalkOptions)`

`pw.streamSync(entry?: string | Path | WalkOptions, opts?: WalkOptions)`

`pw.cwd`

`pw.chdir(path: string)`

`pw.depth(path?: Path | string): number`

`pw.resolve(...paths: string[])`

`pw.resolvePosix(...paths: string[])`

`pw.relative(path: string | Path): string`

`pw.relativePosix(path: string | Path): string`

`pw.basename(path: string | Path): string`

`pw.dirname(path: string | Path): string`

`async pw.readdir(dir = pw.cwd, opts = { withFileTypes: true })`

`pw.readdirSync(dir = pw.cwd, opts = { withFileTypes: true })`

`async pw.readlink(link = pw.cwd, opts = { withFileTypes: false })`

`pw.readlinkSync(link = pw.cwd, opts = { withFileTypes: false })`

`async pw.lstat(entry = pw.cwd)`

`pw.lstatSync(entry = pw.cwd)`

`pw.realpath(entry = pw.cwd, opts = { withFileTypes: false })`

`pw.realpathSync(entry = pw.cwd, opts = { withFileTypes: false })`

Class `Path` implements fs.Dirent

`path.name`

`path.isNamed(name: string): boolean`

`path.isCWD`

`path.getType()`

`path.isType(t: type)`

`path.depth()`

`path.fullpath()`

`path.fullpathPosix()`

`path.isFile()`, `path.isDirectory()`, etc.

`path.isUnknown()`

`path.resolve(p: string)`

`path.relative(): string`

`path.relativePosix(): string`

`async path.readdir()`

`path.readdirSync()`

`async path.readlink()`

`path.readlinkSync()`

`async path.lstat()`

`path.lstatSync()`

`async path.realpath()`

`path.realpathSync()`