Path

An immutable class for operating on file system paths. Will normalize path separators based on the operating system, "/" on Linux/MacOS, and "\" on Windows.

Hierarchy

• Path
  • VirtualPath

Implements

• Pathable

Index

Constructors

• constructor

Properties

• DELIMITER
• SEP

Methods

• append
• equals
• exists
• ext
• isAbsolute
• isDirectory
• isFile
• name
• parent
• path
• prepend
• realPath
• relativeTo
• resolve
• toJSON
• toString
• create
• path
• resolve

Constructors

constructor

• new Path(...parts: PortablePath[]): Path

Properties

staticDELIMITER

DELIMITER: ; | : = path.delimiter

staticSEP

SEP: \ | / = path.sep

Methods

append

• append(...parts: PortablePath[]): Path

• Append path parts to the end of the current path and return a new Path instance.

equals

• equals(filePath: PortablePath): boolean

• Returns true if both paths are equal using strict equality.

exists

• exists(): boolean

• Return true if the current path exists.

ext

• ext(withoutPeriod?: boolean): string

• Return the extension (if applicable) with or without leading period.

isAbsolute

• isAbsolute(): boolean

• Return true if the current path is absolute.

isDirectory

• isDirectory(): boolean

• Return true if the current path is a folder.

isFile

• isFile(): boolean

• Return true if the current path is a file.

name

• name(withoutExtension?: boolean): string

• Return the file name (with optional extension) or folder name.

parent

• parent(): Path

• Return the parent folder as a new Path instance.

path

• path(): string

• Implementation of Pathable.path

  Return the current path as a normalized string.

prepend

• prepend(...parts: PortablePath[]): Path

• Prepend path parts to the beginning of the current path and return a new Path instance.

realPath

• realPath(): string

• Returns a canonical path by resolving directories and symlinks.

relativeTo

• relativeTo(to: PortablePath): Path

• Return a new relative Path instance from the current "from" path to the defined "to" path.

resolve

• resolve(cwd?: PortablePath): Path

• Return a new Path instance where the current path is accurately resolved against the defined working directory.

toJSON

• toJSON(): string

toString

• toString(): string

• Implementation of Pathable.toString

staticcreate

• create(filePath: PortablePath): Path

• Create and return a new Path instance.

staticpath

• path(part: PortablePath): string

• Convert a path-like value to a formatted path string.

staticresolve

• resolve(filePath: PortablePath, cwd?: PortablePath): Path

• Like create() but also resolves the path against a working directory.