PathBase | path-scurry (original) (raw)

• path-scurry
• PathBase

Class PathBaseAbstract

Hierarchy

• PathBase
  • PathWin32
  • PathPosix

Implements

• Dirent

Index

Constructors

constructor

• new PathBase(name: string, type?: number, root: undefined | PathBase, roots: {
  [k: string]: PathBase;
  }, nocase: boolean, children: ChildrenCache, opts: PathOpts): PathBase
• Internal

Parameters

• name: string

• type: number = UNKNOWN

• root: undefined | PathBase

• roots: {

[k: string]: PathBase;
}
* ##### [k: string]: PathBase

• nocase: boolean

• children: ChildrenCache

• opts: PathOpts

Returns PathBase

Properties

Private Optional #asyncReaddirInFlight

#asyncReaddirInFlight?: Promise<void>

Private Optional #atime

#atime?: Date

Private Optional #atimeMs

#atimeMs?: number

Private Optional #birthtime

#birthtime?: Date

Private Optional #birthtimeMs

#birthtimeMs?: number

Private Optional #blksize

#blksize?: number

Private Optional #blocks

#blocks?: number

Private #children

Private Optional #ctime

#ctime?: Date

Private Optional #ctimeMs

#ctimeMs?: number

Private Optional #depth

#depth?: number

Private Optional #dev

#dev?: number

Private #fs

#fs: FSValue

Private Optional #fullpath

#fullpath?: string

Private Optional #fullpathPosix

#fullpathPosix?: string

Private Optional #gid

#gid?: number

Private Optional #ino

#ino?: number

Private Optional #linkTarget

Private #matchName

#matchName: string

Private Optional #mode

#mode?: number

Private Optional #mtime

#mtime?: Date

Private Optional #mtimeMs

#mtimeMs?: number

Private Optional #nlink

#nlink?: number

Private #onReaddirCB

#onReaddirCB: ((er: null | ErrnoException, entries: Path[]) => any)[] = []

Private Optional #rdev

#rdev?: number

Private #readdirCBInFlight

#readdirCBInFlight: boolean = false

Private Optional #realpath

Private Optional #relative

#relative?: string

Private Optional #relativePosix

#relativePosix?: string

Private Optional #size

#size?: number

Private #type

#type: number

Private Optional #uid

#uid?: number

name

name: string

Internal nocase

nocase: boolean

Optional Internal parent

Internal root

Internal roots

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

Abstract sep

sep: string

Abstract splitSep

splitSep: string | RegExp

Accessors

atime

• get atime(): undefined | Date

• Returns undefined | Date

atimeMs

• get atimeMs(): undefined | number

• Returns undefined | number

birthtime

• get birthtime(): undefined | Date

• Returns undefined | Date

birthtimeMs

• get birthtimeMs(): undefined | number

• Returns undefined | number

blksize

• get blksize(): undefined | number

• Returns undefined | number

blocks

• get blocks(): undefined | number

• Returns undefined | number

ctime

• get ctime(): undefined | Date

• Returns undefined | Date

ctimeMs

• get ctimeMs(): undefined | number

• Returns undefined | number

dev

• get dev(): undefined | number

• Returns undefined | number

gid

• get gid(): undefined | number

• Returns undefined | number

ino

• get ino(): undefined | number

• Returns undefined | number

mode

• get mode(): undefined | number

• Returns undefined | number

mtime

• get mtime(): undefined | Date

• Returns undefined | Date

mtimeMs

• get mtimeMs(): undefined | number

• Returns undefined | number

nlink

• get nlink(): undefined | number

• Returns undefined | number

path

• get path(): string

• Returns string

rdev

• get rdev(): undefined | number

• Returns undefined | number

size

• get size(): undefined | number

• Returns undefined | number

uid

• get uid(): undefined | number

• Returns undefined | number

Methods

Private #applyStat

• #applyStat(st: Stats): void

• Parameters

  • st: Stats

Returns void

Private #callOnReaddirCB

• #callOnReaddirCB(children: Path[]): void

• Parameters

  • children: Path[]

Returns void

Private #lstatFail

• #lstatFail(code?: string): void

• Parameters

  • code: string = ''

Returns void

Private #markChildrenENOENT

• #markChildrenENOENT(): void

• Returns void

Private #markENOENT

• #markENOENT(): void

• Returns void

Private #markENOREALPATH

• #markENOREALPATH(): void

• Returns void

Private #markENOTDIR

• #markENOTDIR(): void

• Returns void

Private #readdirAddChild

• #readdirAddChild(e: Dirent, c: Children): PathBase

• Returns PathBase

Private #readdirAddNewChild

• #readdirAddNewChild(e: Dirent, c: Children): PathBase

• Returns PathBase

Private #readdirFail

• #readdirFail(code?: string): void

• Parameters

  • code: string = ''

Returns void

Private #readdirMaybePromoteChild

• #readdirMaybePromoteChild(e: Dirent, c: Children): undefined | PathBase

• Returns undefined | PathBase

Private #readdirPromoteChild

• #readdirPromoteChild(e: Dirent, p: PathBase, index: number, c: Children): PathBase

• Returns PathBase

Private #readdirSuccess

• #readdirSuccess(children: Children): void

• Returns void

Private #readlinkFail

• #readlinkFail(code?: string): void

• Parameters

  • code: string = ''

Returns void

Private #resolveParts

• #resolveParts(dirParts: string[]): PathBase

• Parameters

  • dirParts: string[]

Returns PathBase

[setAsCwd]

• [setAsCwd](oldCwd: PathBase): void
• Internal

Returns void

calledReaddir

• calledReaddir(): boolean

• Returns boolean

canReaddir

• canReaddir(): boolean

• Returns boolean

canReadlink

• canReadlink(): boolean

• Returns boolean

child

• child(pathPart: string, opts?: PathOpts): PathBase
• Internal

Parameters

• pathPart: string

• Optional opts: PathOpts

Returns PathBase

children

• children(): Children
• Internal

Returns Children

childrenCache

• childrenCache(): ChildrenCache
• Internal

Returns ChildrenCache

depth

• depth(): number

• Returns number

fullpath

• fullpath(): string

• Returns string

fullpathPosix

• fullpathPosix(): string

• Returns string

Abstract getRoot

• getRoot(rootPath: string): PathBase
• Internal

Parameters

• rootPath: string

Returns PathBase

Abstract getRootString

• getRootString(path: string): string
• Internal

Parameters

• path: string

Returns string

getType

• getType(): Type

• Returns Type

isBlockDevice

• isBlockDevice(): boolean

• Returns boolean

isCharacterDevice

• isCharacterDevice(): boolean

• Returns boolean

isDirectory

• isDirectory(): boolean

• Returns boolean

isENOENT

• isENOENT(): boolean

• Returns boolean

isFIFO

• isFIFO(): boolean

• Returns boolean

isFile

• isFile(): boolean

• Returns boolean

isNamed

• isNamed(n: string): boolean

• Parameters

  • n: string

Returns boolean

isSocket

• isSocket(): boolean

• Returns boolean

isSymbolicLink

• isSymbolicLink(): boolean

• Returns boolean

isType

• isType(type: Type): boolean

• Parameters

  • type: Type

Returns boolean

isUnknown

• isUnknown(): boolean

• Returns boolean

lstat

• lstat(): Promise<undefined | PathBase>

• Returns Promise<undefined | PathBase>

lstatCached

• lstatCached(): undefined | PathBase

• Returns undefined | PathBase

lstatSync

• lstatSync(): undefined | PathBase

• Returns undefined | PathBase

Abstract newChild

• newChild(name: string, type?: number, opts?: PathOpts): PathBase
• Internal

Parameters

• name: string

• Optional type: number

• Optional opts: PathOpts

Returns PathBase

readdir

• readdir(): Promise<PathBase[]>

• Returns Promise<PathBase[]>

readdirCB

• readdirCB(cb: ((er: null | ErrnoException, entries: PathBase[]) => any), allowZalgo?: boolean): void

• Parameters

  • cb: ((er: null | ErrnoException, entries: PathBase[]) => any)

    * * (er: null | ErrnoException, entries: [PathBase](PathBase.html)\[\]): any  
             * #### Parameters  
                         * ##### er: null | ErrnoException  
                         * ##### entries: [PathBase](PathBase.html)\[\]  
             #### Returns any  

  • allowZalgo: boolean = false

Returns void

readdirCached

• readdirCached(): PathBase[]

• Returns PathBase[]

readdirSync

• readdirSync(): PathBase[]

• Returns PathBase[]

readlink

• readlink(): Promise<undefined | PathBase>

• Returns Promise<undefined | PathBase>

readlinkCached

• readlinkCached(): undefined | PathBase

• Returns undefined | PathBase

readlinkSync

• readlinkSync(): undefined | PathBase

• Returns undefined | PathBase

realpath

• realpath(): Promise<undefined | PathBase>

• Returns Promise<undefined | PathBase>

realpathCached

• realpathCached(): undefined | PathBase

• Returns undefined | PathBase

realpathSync

• realpathSync(): undefined | PathBase

• Returns undefined | PathBase

relative

• relative(): string

• Returns string

relativePosix

• relativePosix(): string

• Returns string

resolve

• resolve(path?: string): PathBase

• Parameters

  • Optional path: string

Returns PathBase

shouldWalk

• shouldWalk(dirs: Set<undefined | PathBase>, walkFilter?: ((e: PathBase) => boolean)): boolean

• Parameters

  • dirs: Set<undefined | PathBase>

  • Optional walkFilter: ((e: PathBase) => boolean)

    * * (e: [PathBase](PathBase.html)): boolean  
             * #### Returns boolean

Returns boolean