Class PathPosix

Path class used on all posix systems.

Uses '/' as the path separator.

Hierarchy

Constructors

constructor

Properties

#asyncReaddirInFlight? #atime? #atimeMs? #birthtime? #birthtimeMs? #blksize? #blocks? #children #ctime? #ctimeMs? #depth? #dev? #fs #fullpath? #fullpathPosix? #gid? #ino? #linkTarget? #matchName #mode? #mtime? #mtimeMs? #nlink? #onReaddirCB #rdev? #readdirCBInFlight #realpath? #relative? #relativePosix? #size? #type #uid? name nocase parent? root roots sep splitSep

Accessors

atime atimeMs birthtime birthtimeMs blksize blocks ctime ctimeMs dev gid ino mode mtime mtimeMs nlink path rdev size uid

Methods

#applyStat #callOnReaddirCB #lstatFail #markChildrenENOENT #markENOENT #markENOREALPATH #markENOTDIR #readdirAddChild #readdirAddNewChild #readdirFail #readdirMaybePromoteChild #readdirPromoteChild #readdirSuccess #readlinkFail #resolveParts [setAsCwd] calledReaddir canReaddir canReadlink child children childrenCache depth fullpath fullpathPosix getRoot getRootString getType isBlockDevice isCharacterDevice isDirectory isENOENT isFIFO isFile isNamed isSocket isSymbolicLink isType isUnknown lstat lstatCached lstatSync newChild readdir readdirCB readdirCached readdirSync readlink readlinkCached readlinkSync realpath realpathCached realpathSync relative relativePosix resolve shouldWalk

Constructors

constructor

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

#children: ChildrenCache

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

#linkTarget?: PathBase

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

#realpath?: PathBase

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

the basename of this path

Important: always test the path name against any test string usingthe isNamed method, and not by directly comparing this string. Otherwise, unicode path strings that the system sees as identical will not be properly treated as the same path, leading to incorrect behavior and possible security issues.

Internal nocase

nocase: boolean

boolean indicating whether paths are compared case-insensitively

Optional Internal parent

parent?: PathBase

a reference to the parent path, or undefined in the case of root entries

Internal root

root: PathBase

the Path entry corresponding to the path root.

Internal roots

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

All roots found within the current PathScurry family

Type declaration

sep

sep: "/" = '/'

separator for generating path strings

splitSep

splitSep: "/" = '/'

separator for parsing path strings

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

  • Returns undefined | number

path

  • get path(): string

  • This property is for compatibility with the Dirent class as of Node v20, where Dirent['path'] refers to the path of the directory that was passed to readdir. So, somewhat counterintuitively, this property refers to the parent path, not the path object itself. For root entries, it's the path to the entry itself.

    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

Private #callOnReaddirCB

Private #lstatFail

Private #markChildrenENOENT

Private #markENOENT

Private #markENOREALPATH

Private #markENOTDIR

Private #readdirAddChild

Private #readdirAddNewChild

Private #readdirFail

Private #readdirMaybePromoteChild

Private #readdirPromoteChild

Private #readdirSuccess

Private #readlinkFail

Private #resolveParts

[setAsCwd]

calledReaddir

  • Return true if readdir has previously been successfully called on this path, indicating that cachedReaddir() is likely valid.

    Returns boolean

canReaddir

canReadlink

  • Return true if it's worth trying to readlink. Ie, we don't (yet) have any indication that readlink will definitely fail.

    Returns false if the path is known to not be a symlink, if a previous readlink failed, or if the entry does not exist.

    Returns boolean

child

  • Internal

    Resolves a path portion and returns or creates the child Path.

    Returns this if pathPart is '' or '.', or parent if pathPart is '..'.

    This should not be called directly. If pathPart contains any path separators, it will lead to unsafe undefined behavior.

    Use Path.resolve() instead.

    Parameters

    • pathPart: string
    • Optional opts: PathOpts

    Returns PathBase

children

  • Internal

    Returns the cached children Path objects, if still available. If they have fallen out of the cache, then returns an empty array, and resets the READDIR_CALLED bit, so that future calls to readdir() will require an fs lookup.

    Returns Children

childrenCache

depth

  • Returns the depth of the Path object from its root.

    For example, a path at /foo/bar would have a depth of 2.

    Returns number

fullpath

fullpathPosix

  • On platforms other than windows, this is identical to fullpath.

    On windows, this is overridden to return the forward-slash form of the full UNC path.

    Returns string

getRoot

getRootString

getType

isBlockDevice

isCharacterDevice

isDirectory

isENOENT

  • Returns true if the path is known to not exist. That is, a previous lstat or readdir failed to verify its existence when that would have been expected, or a parent entry was marked either enoent or enotdir.

    Returns boolean

isFIFO

isFile

isNamed

  • Return true if the path is a match for the given path name. This handles case sensitivity and unicode normalization.

    Note: even on case-sensitive systems, it is not safe to test the equality of the .name property to determine whether a given pathname matches, due to unicode normalization mismatches.

    Always use this method instead of testing the path.name property directly.

    Parameters

    • n: string

    Returns boolean

isSocket

isSymbolicLink

isType

isUnknown

  • Is the Path of an unknown type?

    Note that we might know something about it if there has been a previous filesystem operation, for example that it does not exist, or is not a link, or whether it has child entries.

    Returns boolean

lstat

  • Call lstat() on this Path, and update all known information that can be determined.

    Note that unlike fs.lstat(), the returned value does not contain some information, such as mode, dev, nlink, and ino. If that information is required, you will need to call fs.lstat yourself.

    If the Path refers to a nonexistent file, or if the lstat call fails for any reason, undefined is returned. Otherwise the updated Path object is returned.

    Results are cached, and thus may be out of date if the filesystem is mutated.

    Returns Promise<undefined | PathBase>

lstatCached

  • Return the entry if it has been subject of a successful lstat, or undefined otherwise.

    Does not read the filesystem, so an undefined result could simply mean that we haven't called lstat on it.

    Returns undefined | PathBase

lstatSync

newChild

readdir

  • Return an array of known child entries.

    If the Path cannot or does not contain any children, then an empty array is returned.

    Results are cached, and thus may be out of date if the filesystem is mutated.

    Returns Promise<PathBase[]>

readdirCB

  • Standard node-style callback interface to get list of directory entries.

    If the Path cannot or does not contain any children, then an empty array is returned.

    Results are cached, and thus may be out of date if the filesystem is mutated.

    Parameters

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

      The callback called with (er, entries). Note that the er param is somewhat extraneous, as all readdir() errors are handled and simply result in an empty set of entries being returned.

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

        • Parameters

          • er: null | ErrnoException
          • entries: PathBase[]

          Returns any

    • allowZalgo: boolean = false

      Boolean indicating that immediately known results should not be deferred with queueMicrotask. Defaults to false. Release zalgo at your peril, the dark pony lord is devious and unforgiving.

    Returns void

readdirCached

  • Returns the cached child Path entries array if the entry has been the subject of a successful readdir(), or [] otherwise.

    Does not read the filesystem, so an empty array could just mean we don't have any cached data. Only use it if you are very sure that a readdir() has been called recently enough to still be valid.

    Returns PathBase[]

readdirSync

readlink

  • Return the Path object corresponding to the target of a symbolic link.

    If the Path is not a symbolic link, or if the readlink call fails for any reason, undefined is returned.

    Result is cached, and thus may be outdated if the filesystem is mutated.

    Returns Promise<undefined | PathBase>

readlinkCached

  • Return the cached link target if the entry has been the subject of a successful readlink, or undefined otherwise.

    Does not read the filesystem, so an undefined result could just mean we don't have any cached data. Only use it if you are very sure that a readlink() has been called at some point.

    Returns undefined | PathBase

readlinkSync

realpath

  • Return the Path object corresponding to path as resolved by realpath(3).

    If the realpath call fails for any reason, undefined is returned.

    Result is cached, and thus may be outdated if the filesystem is mutated. On success, returns a Path object.

    Returns Promise<undefined | PathBase>

realpathCached

  • Returns the cached realpath target if the entry has been the subject of a successful realpath, or undefined otherwise.

    Does not read the filesystem, so an undefined result could just mean we don't have any cached data. Only use it if you are very sure that a realpath() has been called at some point.

    Returns undefined | PathBase

realpathSync

relative

  • The relative path from the cwd. If it does not share an ancestor with the cwd, then this ends up being equivalent to the fullpath()

    Returns string

relativePosix

  • The relative path from the cwd, using / as the path separator. If it does not share an ancestor with the cwd, then this ends up being equivalent to the fullpathPosix() On posix systems, this is identical to relative().

    Returns string

resolve

shouldWalk

Settings

Member Visibility

Theme

Generated using TypeDoc