Interface PlatformPath

Readonly delimiter

Readonly posix

Readonly sep

Readonly win32

basename

• basename(path, suffix?): string

• Return the last portion of a path. Similar to the Unix basename command. Often used to extract the file name from a fully qualified path.

  Parameters

  • path: string

    the path to evaluate.

  • Optional suffix: string

    optionally, an extension to remove from the result.

  Returns string

  Throws

  if path is not a string or if ext is given and is not a string.

dirname

• dirname(path): string

• Return the directory name of a path. Similar to the Unix dirname command.

  Parameters

  • path: string

    the path to evaluate.

  Returns string

  Throws

  if path is not a string.

extname

• extname(path): string

• Return the extension of the path, from the last '.' to end of string in the last portion of the path. If there is no '.' in the last portion of the path or the first character of it is '.', then it returns an empty string.

  Parameters

  • path: string

    the path to evaluate.

  Returns string

  Throws

  if path is not a string.

format

• format(pathObject): string

• Returns a path string from an object - the opposite of parse().

  Parameters

  • pathObject: FormatInputPathObject

    path to evaluate.

  Returns string

isAbsolute

• isAbsolute(path): boolean

• Determines whether {path} is an absolute path. An absolute path will always resolve to the same location, regardless of the working directory.

  If the given {path} is a zero-length string, false will be returned.

  Parameters

  • path: string

    path to test.

  Returns boolean

  Throws

  if path is not a string.

join

• join(...paths): string

• Join all arguments together and normalize the resulting path.

  Parameters

  • Rest ...paths: string[]

    paths to join.

  Returns string

  Throws

  if any of the path segments is not a string.

normalize

• normalize(path): string

• Normalize a string path, reducing '..' and '.' parts. When multiple slashes are found, they're replaced by a single one; when the path contains a trailing slash, it is preserved. On Windows backslashes are used.

  Parameters

  • path: string

    string path to normalize.

  Returns string

  Throws

  if path is not a string.

parse

• parse(path): ParsedPath

• Returns an object from a path string - the opposite of format().

  Parameters

  • path: string

    path to evaluate.

  Returns ParsedPath

  Throws

  if path is not a string.

relative

• relative(from, to): string

• Solve the relative path from {from} to {to} based on the current working directory. At times we have two absolute paths, and we need to derive the relative path from one to the other. This is actually the reverse transform of path.resolve.

  Parameters

  • from: string

  • to: string

  Returns string

  Throws

  if either from or to is not a string.

resolve

• resolve(...paths): string

• The right-most parameter is considered {to}. Other parameters are considered an array of {from}.

  Starting from leftmost {from} parameter, resolves {to} to an absolute path.

  If {to} isn't already absolute, {from} arguments are prepended in right to left order, until an absolute path is found. If after using all {from} paths still no absolute path is found, the current working directory is used as well. The resulting path is normalized, and trailing slashes are removed unless the path gets resolved to the root directory.

  Parameters

  • Rest ...paths: string[]

    A sequence of paths or path segments.

  Returns string

  Throws

  if any of the arguments is not a string.

toNamespacedPath

• toNamespacedPath(path): string

• On Windows systems only, returns an equivalent namespace-prefixed path for the given path. If path is not a string, path will be returned without modifications. This method is meaningful only on Windows system. On POSIX systems, the method is non-operational and always returns path without modifications.

  Parameters

  • path: string

  Returns string