PathScurryBase | path-scurry (original) (raw)

• path-scurry
• PathScurryBase

Class PathScurryBaseAbstract

Hierarchy

• PathScurryBase
  • PathScurryWin32
  • PathScurryPosix

Index

Constructors

constructor

• new PathScurryBase(cwd?: string | URL, pathImpl: PlatformPath, sep: string | RegExp, __namedParameters?: PathScurryOpts): PathScurryBase
• Internal

Parameters

• cwd: string | URL = ...

• pathImpl: PlatformPath

• sep: string | RegExp

• __namedParameters: PathScurryOpts = {}

Returns PathScurryBase

Properties

Private #children

Private #fs

#fs: FSValue

Private #resolveCache

Private #resolvePosixCache

cwd

nocase

nocase: boolean

root

rootPath

rootPath: string

roots

roots: {
[k: string]: PathBase;
}

Abstract sep

sep: string | RegExp

Methods

[asyncIterator]

• [asyncIterator](): AsyncGenerator<PathBase, void, void>

• Returns AsyncGenerator<PathBase, void, void>

[iterator]

• [iterator](): Generator<PathBase, void, void>

• Returns Generator<PathBase, void, void>

basename

• basename(entry?: string | PathBase): string

• Parameters

  • entry: string | PathBase = ...

Returns string

chdir

• chdir(path?: string | Path): void

• Parameters

  • path: string | Path = ...

Returns void

childrenCache

• childrenCache(): ChildrenCache
• Internal

Returns ChildrenCache

depth

• depth(path?: string | Path): number

• Parameters

  • path: string | Path = ...

Returns number

dirname

• dirname(entry?: string | PathBase): string

• Parameters

  • entry: string | PathBase = ...

Returns string

Abstract isAbsolute

• isAbsolute(p: string): boolean

• Parameters

  • p: string

Returns boolean

iterate

• iterate(): AsyncGenerator<PathBase, void, void>

• Returns AsyncGenerator<PathBase, void, void>

• iterate(opts: WalkOptionsWithFileTypesTrue | WalkOptionsWithFileTypesUnset): AsyncGenerator<PathBase, void, void>

• Returns AsyncGenerator<PathBase, void, void>

• iterate(opts: WalkOptionsWithFileTypesFalse): AsyncGenerator<string, void, void>

• Returns AsyncGenerator<string, void, void>

• iterate(opts: WalkOptions): AsyncGenerator<string | PathBase, void, void>

• Returns AsyncGenerator<string | PathBase, void, void>

• iterate(entry: string | PathBase): AsyncGenerator<PathBase, void, void>

• Returns AsyncGenerator<PathBase, void, void>

• iterate(entry: string | PathBase, opts: WalkOptionsWithFileTypesTrue | WalkOptionsWithFileTypesUnset): AsyncGenerator<PathBase, void, void>

• Returns AsyncGenerator<PathBase, void, void>

• iterate(entry: string | PathBase, opts: WalkOptionsWithFileTypesFalse): AsyncGenerator<string, void, void>

• Returns AsyncGenerator<string, void, void>

• iterate(entry: string | PathBase, opts: WalkOptions): AsyncGenerator<string | PathBase, void, void>

• Returns AsyncGenerator<string | PathBase, void, void>

iterateSync

• iterateSync(): Generator<PathBase, void, void>

• Returns Generator<PathBase, void, void>

• iterateSync(opts: WalkOptionsWithFileTypesTrue | WalkOptionsWithFileTypesUnset): Generator<PathBase, void, void>

• Returns Generator<PathBase, void, void>

• iterateSync(opts: WalkOptionsWithFileTypesFalse): Generator<string, void, void>

• Returns Generator<string, void, void>

• iterateSync(opts: WalkOptions): Generator<string | PathBase, void, void>

• Returns Generator<string | PathBase, void, void>

• iterateSync(entry: string | PathBase): Generator<PathBase, void, void>

• Returns Generator<PathBase, void, void>

• iterateSync(entry: string | PathBase, opts: WalkOptionsWithFileTypesTrue | WalkOptionsWithFileTypesUnset): Generator<PathBase, void, void>

• Returns Generator<PathBase, void, void>

• iterateSync(entry: string | PathBase, opts: WalkOptionsWithFileTypesFalse): Generator<string, void, void>

• Returns Generator<string, void, void>

• iterateSync(entry: string | PathBase, opts: WalkOptions): Generator<string | PathBase, void, void>

• Returns Generator<string | PathBase, void, void>

lstat

• lstat(entry?: string | PathBase): Promise<undefined | PathBase>

• Parameters

  • entry: string | PathBase = ...

Returns Promise<undefined | PathBase>

lstatSync

• lstatSync(entry?: string | PathBase): undefined | PathBase

• Parameters

  • entry: string | PathBase = ...

Returns undefined | PathBase

Abstract newRoot

• newRoot(fs: FSValue): PathBase
• Internal

Parameters

• fs: FSValue

Returns PathBase

Abstract parseRootPath

• parseRootPath(dir: string): string
• Internal

Parameters

• dir: string

Returns string

readdir

• readdir(): Promise<PathBase[]>

• Returns Promise<PathBase[]>

• readdir(opts: {
  withFileTypes: true;
  }): Promise<PathBase[]>

• Parameters

  • opts: {

  withFileTypes: true;
  }
  * ##### withFileTypes: true

Returns Promise<PathBase[]>

• readdir(opts: {
  withFileTypes: false;
  }): Promise<string[]>

• Parameters

  • opts: {

  withFileTypes: false;
  }
  * ##### withFileTypes: false

Returns Promise<string[]>

• readdir(opts: {
  withFileTypes: boolean;
  }): Promise<string[] | PathBase[]>

• Parameters

  • opts: {

  withFileTypes: boolean;
  }
  * ##### withFileTypes: boolean

Returns Promise<string[] | PathBase[]>

• readdir(entry: string | PathBase): Promise<PathBase[]>

• Returns Promise<PathBase[]>

• readdir(entry: string | PathBase, opts: {
  withFileTypes: true;
  }): Promise<PathBase[]>

• Parameters

  • entry: string | PathBase

  • opts: {

  withFileTypes: true;
  }
  * ##### withFileTypes: true

Returns Promise<PathBase[]>

• readdir(entry: string | PathBase, opts: {
  withFileTypes: false;
  }): Promise<string[]>

• Parameters

  • entry: string | PathBase

  • opts: {

  withFileTypes: false;
  }
  * ##### withFileTypes: false

Returns Promise<string[]>

• readdir(entry: string | PathBase, opts: {
  withFileTypes: boolean;
  }): Promise<string[] | PathBase[]>

• Parameters

  • entry: string | PathBase

  • opts: {

  withFileTypes: boolean;
  }
  * ##### withFileTypes: boolean

Returns Promise<string[] | PathBase[]>

readdirSync

• readdirSync(): PathBase[]

• Returns PathBase[]

• readdirSync(opts: {
  withFileTypes: true;
  }): PathBase[]

• Parameters

  • opts: {

  withFileTypes: true;
  }
  * ##### withFileTypes: true

Returns PathBase[]

• readdirSync(opts: {
  withFileTypes: false;
  }): string[]

• Parameters

  • opts: {

  withFileTypes: false;
  }
  * ##### withFileTypes: false

Returns string[]

• readdirSync(opts: {
  withFileTypes: boolean;
  }): string[] | PathBase[]

• Parameters

  • opts: {

  withFileTypes: boolean;
  }
  * ##### withFileTypes: boolean

Returns string[] | PathBase[]

• readdirSync(entry: string | PathBase): PathBase[]

• Returns PathBase[]

• readdirSync(entry: string | PathBase, opts: {
  withFileTypes: true;
  }): PathBase[]

• Parameters

  • entry: string | PathBase

  • opts: {

  withFileTypes: true;
  }
  * ##### withFileTypes: true

Returns PathBase[]

• readdirSync(entry: string | PathBase, opts: {
  withFileTypes: false;
  }): string[]

• Parameters

  • entry: string | PathBase

  • opts: {

  withFileTypes: false;
  }
  * ##### withFileTypes: false

Returns string[]

• readdirSync(entry: string | PathBase, opts: {
  withFileTypes: boolean;
  }): string[] | PathBase[]

• Parameters

  • entry: string | PathBase

  • opts: {

  withFileTypes: boolean;
  }
  * ##### withFileTypes: boolean

Returns string[] | PathBase[]

readlink

• readlink(): Promise<undefined | string>

• Returns Promise<undefined | string>

• readlink(opt: {
  withFileTypes: false;
  }): Promise<undefined | string>

• Parameters

  • opt: {

  withFileTypes: false;
  }
  * ##### withFileTypes: false

Returns Promise<undefined | string>

• readlink(opt: {
  withFileTypes: true;
  }): Promise<undefined | PathBase>

• Parameters

  • opt: {

  withFileTypes: true;
  }
  * ##### withFileTypes: true

Returns Promise<undefined | PathBase>

• readlink(opt: {
  withFileTypes: boolean;
  }): Promise<undefined | string | PathBase>

• Parameters

  • opt: {

  withFileTypes: boolean;
  }
  * ##### withFileTypes: boolean

Returns Promise<undefined | string | PathBase>

• readlink(entry: string | PathBase, opt?: {
  withFileTypes: false;
  }): Promise<undefined | string>

• Parameters

  • entry: string | PathBase

  • Optional opt: {

  withFileTypes: false;
  }
  * ##### withFileTypes: false

Returns Promise<undefined | string>

• readlink(entry: string | PathBase, opt: {
  withFileTypes: true;
  }): Promise<undefined | PathBase>

• Parameters

  • entry: string | PathBase

  • opt: {

  withFileTypes: true;
  }
  * ##### withFileTypes: true

Returns Promise<undefined | PathBase>

• readlink(entry: string | PathBase, opt: {
  withFileTypes: boolean;
  }): Promise<undefined | string | PathBase>

• Parameters

  • entry: string | PathBase

  • opt: {

  withFileTypes: boolean;
  }
  * ##### withFileTypes: boolean

Returns Promise<undefined | string | PathBase>

readlinkSync

• readlinkSync(): undefined | string

• Returns undefined | string

• readlinkSync(opt: {
  withFileTypes: false;
  }): undefined | string

• Parameters

  • opt: {

  withFileTypes: false;
  }
  * ##### withFileTypes: false

Returns undefined | string

• readlinkSync(opt: {
  withFileTypes: true;
  }): undefined | PathBase

• Parameters

  • opt: {

  withFileTypes: true;
  }
  * ##### withFileTypes: true

Returns undefined | PathBase

• readlinkSync(opt: {
  withFileTypes: boolean;
  }): undefined | string | PathBase

• Parameters

  • opt: {

  withFileTypes: boolean;
  }
  * ##### withFileTypes: boolean

Returns undefined | string | PathBase

• readlinkSync(entry: string | PathBase, opt?: {
  withFileTypes: false;
  }): undefined | string

• Parameters

  • entry: string | PathBase

  • Optional opt: {

  withFileTypes: false;
  }
  * ##### withFileTypes: false

Returns undefined | string

• readlinkSync(entry: string | PathBase, opt: {
  withFileTypes: true;
  }): undefined | PathBase

• Parameters

  • entry: string | PathBase

  • opt: {

  withFileTypes: true;
  }
  * ##### withFileTypes: true

Returns undefined | PathBase

• readlinkSync(entry: string | PathBase, opt: {
  withFileTypes: boolean;
  }): undefined | string | PathBase

• Parameters

  • entry: string | PathBase

  • opt: {

  withFileTypes: boolean;
  }
  * ##### withFileTypes: boolean

Returns undefined | string | PathBase

realpath

• realpath(): Promise<undefined | string>

• Returns Promise<undefined | string>

• realpath(opt: {
  withFileTypes: false;
  }): Promise<undefined | string>

• Parameters

  • opt: {

  withFileTypes: false;
  }
  * ##### withFileTypes: false

Returns Promise<undefined | string>

• realpath(opt: {
  withFileTypes: true;
  }): Promise<undefined | PathBase>

• Parameters

  • opt: {

  withFileTypes: true;
  }
  * ##### withFileTypes: true

Returns Promise<undefined | PathBase>

• realpath(opt: {
  withFileTypes: boolean;
  }): Promise<undefined | string | PathBase>

• Parameters

  • opt: {

  withFileTypes: boolean;
  }
  * ##### withFileTypes: boolean

Returns Promise<undefined | string | PathBase>

• realpath(entry: string | PathBase, opt?: {
  withFileTypes: false;
  }): Promise<undefined | string>

• Parameters

  • entry: string | PathBase

  • Optional opt: {

  withFileTypes: false;
  }
  * ##### withFileTypes: false

Returns Promise<undefined | string>

• realpath(entry: string | PathBase, opt: {
  withFileTypes: true;
  }): Promise<undefined | PathBase>

• Parameters

  • entry: string | PathBase

  • opt: {

  withFileTypes: true;
  }
  * ##### withFileTypes: true

Returns Promise<undefined | PathBase>

• realpath(entry: string | PathBase, opt: {
  withFileTypes: boolean;
  }): Promise<undefined | string | PathBase>

• Parameters

  • entry: string | PathBase

  • opt: {

  withFileTypes: boolean;
  }
  * ##### withFileTypes: boolean

Returns Promise<undefined | string | PathBase>

realpathSync

• realpathSync(): undefined | string

• Returns undefined | string

• realpathSync(opt: {
  withFileTypes: false;
  }): undefined | string

• Parameters

  • opt: {

  withFileTypes: false;
  }
  * ##### withFileTypes: false

Returns undefined | string

• realpathSync(opt: {
  withFileTypes: true;
  }): undefined | PathBase

• Parameters

  • opt: {

  withFileTypes: true;
  }
  * ##### withFileTypes: true

Returns undefined | PathBase

• realpathSync(opt: {
  withFileTypes: boolean;
  }): undefined | string | PathBase

• Parameters

  • opt: {

  withFileTypes: boolean;
  }
  * ##### withFileTypes: boolean

Returns undefined | string | PathBase

• realpathSync(entry: string | PathBase, opt?: {
  withFileTypes: false;
  }): undefined | string

• Parameters

  • entry: string | PathBase

  • Optional opt: {

  withFileTypes: false;
  }
  * ##### withFileTypes: false

Returns undefined | string

• realpathSync(entry: string | PathBase, opt: {
  withFileTypes: true;
  }): undefined | PathBase

• Parameters

  • entry: string | PathBase

  • opt: {

  withFileTypes: true;
  }
  * ##### withFileTypes: true

Returns undefined | PathBase

• realpathSync(entry: string | PathBase, opt: {
  withFileTypes: boolean;
  }): undefined | string | PathBase

• Parameters

  • entry: string | PathBase

  • opt: {

  withFileTypes: boolean;
  }
  * ##### withFileTypes: boolean

Returns undefined | string | PathBase

relative

• relative(entry?: string | PathBase): string

• Parameters

  • entry: string | PathBase = ...

Returns string

relativePosix

• relativePosix(entry?: string | PathBase): string

• Parameters

  • entry: string | PathBase = ...

Returns string

resolve

• resolve(...paths: string[]): string

• Parameters

  • Rest ...paths: string[]

Returns string

resolvePosix

• resolvePosix(...paths: string[]): string

• Parameters

  • Rest ...paths: string[]

Returns string

stream

• stream(): Minipass<PathBase, PathBase, Events<PathBase>>

• Returns Minipass<PathBase, PathBase, Events<PathBase>>

• stream(opts: WalkOptionsWithFileTypesTrue | WalkOptionsWithFileTypesUnset): Minipass<PathBase, PathBase, Events<PathBase>>

• Returns Minipass<PathBase, PathBase, Events<PathBase>>

• stream(opts: WalkOptionsWithFileTypesFalse): Minipass<string, ContiguousData, Events<string>>

• Returns Minipass<string, ContiguousData, Events<string>>

• stream(opts: WalkOptions): Minipass<string | PathBase, ContiguousData | PathBase, Events<string | PathBase>>

• Returns Minipass<string | PathBase, ContiguousData | PathBase, Events<string | PathBase>>

• stream(entry: string | PathBase): Minipass<PathBase, PathBase, Events<PathBase>>

• Returns Minipass<PathBase, PathBase, Events<PathBase>>

• stream(entry: string | PathBase, opts: WalkOptionsWithFileTypesTrue | WalkOptionsWithFileTypesUnset): Minipass<PathBase, PathBase, Events<PathBase>>

• Returns Minipass<PathBase, PathBase, Events<PathBase>>

• stream(entry: string | PathBase, opts: WalkOptionsWithFileTypesFalse): Minipass<string, ContiguousData, Events<string>>

• Returns Minipass<string, ContiguousData, Events<string>>

• stream(entry: string | PathBase, opts: WalkOptions): Minipass<string, ContiguousData, Events<string>> | Minipass<PathBase, PathBase, Events<PathBase>>

• Returns Minipass<string, ContiguousData, Events<string>> | Minipass<PathBase, PathBase, Events<PathBase>>

streamSync

• streamSync(): Minipass<PathBase, PathBase, Events<PathBase>>

• Returns Minipass<PathBase, PathBase, Events<PathBase>>

• streamSync(opts: WalkOptionsWithFileTypesTrue | WalkOptionsWithFileTypesUnset): Minipass<PathBase, PathBase, Events<PathBase>>

• Returns Minipass<PathBase, PathBase, Events<PathBase>>

• streamSync(opts: WalkOptionsWithFileTypesFalse): Minipass<string, ContiguousData, Events<string>>

• Returns Minipass<string, ContiguousData, Events<string>>

• streamSync(opts: WalkOptions): Minipass<string | PathBase, ContiguousData | PathBase, Events<string | PathBase>>

• Returns Minipass<string | PathBase, ContiguousData | PathBase, Events<string | PathBase>>

• streamSync(entry: string | PathBase): Minipass<PathBase, PathBase, Events<PathBase>>

• Returns Minipass<PathBase, PathBase, Events<PathBase>>

• streamSync(entry: string | PathBase, opts: WalkOptionsWithFileTypesTrue | WalkOptionsWithFileTypesUnset): Minipass<PathBase, PathBase, Events<PathBase>>

• Returns Minipass<PathBase, PathBase, Events<PathBase>>

• streamSync(entry: string | PathBase, opts: WalkOptionsWithFileTypesFalse): Minipass<string, ContiguousData, Events<string>>

• Returns Minipass<string, ContiguousData, Events<string>>

• streamSync(entry: string | PathBase, opts: WalkOptions): Minipass<string, ContiguousData, Events<string>> | Minipass<PathBase, PathBase, Events<PathBase>>

• Returns Minipass<string, ContiguousData, Events<string>> | Minipass<PathBase, PathBase, Events<PathBase>>

walk

• walk(): Promise<PathBase[]>

• Returns Promise<PathBase[]>

• walk(opts: WalkOptionsWithFileTypesTrue | WalkOptionsWithFileTypesUnset): Promise<PathBase[]>

• Returns Promise<PathBase[]>

• walk(opts: WalkOptionsWithFileTypesFalse): Promise<string[]>

• Returns Promise<string[]>

• walk(opts: WalkOptions): Promise<string[] | PathBase[]>

• Returns Promise<string[] | PathBase[]>

• walk(entry: string | PathBase): Promise<PathBase[]>

• Returns Promise<PathBase[]>

• walk(entry: string | PathBase, opts: WalkOptionsWithFileTypesTrue | WalkOptionsWithFileTypesUnset): Promise<PathBase[]>

• Returns Promise<PathBase[]>

• walk(entry: string | PathBase, opts: WalkOptionsWithFileTypesFalse): Promise<string[]>

• Returns Promise<string[]>

• walk(entry: string | PathBase, opts: WalkOptions): Promise<string[] | PathBase[]>

• Returns Promise<string[] | PathBase[]>

walkSync

• walkSync(): PathBase[]

• Returns PathBase[]

• walkSync(opts: WalkOptionsWithFileTypesTrue | WalkOptionsWithFileTypesUnset): PathBase[]

• Returns PathBase[]

• walkSync(opts: WalkOptionsWithFileTypesFalse): string[]

• Returns string[]

• walkSync(opts: WalkOptions): string[] | PathBase[]

• Returns string[] | PathBase[]

• walkSync(entry: string | PathBase): PathBase[]

• Returns PathBase[]

• walkSync(entry: string | PathBase, opts: WalkOptionsWithFileTypesTrue | WalkOptionsWithFileTypesUnset): PathBase[]

• Returns PathBase[]

• walkSync(entry: string | PathBase, opts: WalkOptionsWithFileTypesFalse): string[]

• Returns string[]

• walkSync(entry: string | PathBase, opts: WalkOptions): string[] | PathBase[]

• Returns string[] | PathBase[]