Options
All
  • Public
  • Public/Protected
  • All
Menu

Module util/PathUtil

Index

Functions

Functions

absoluteFilePath

  • absoluteFilePath(path: string): string

  • Resolves a path to its absolute form. Absolute inputs will not be changed (except changing Windows to POSIX). Relative inputs will be interpreted relative to process.cwd().

    Parameters

    • path: string

      Path to check (POSIX or Windows).

    Returns string

    The potentially changed path (POSIX).

decodeUriPathComponents

  • decodeUriPathComponents(path: string): string

encodeUriPathComponents

  • encodeUriPathComponents(path: string): string

  • Encodes all (non-slash) special characters in a URI path.

    Parameters

    • path: string

    Returns string

ensureTrailingSlash

  • ensureTrailingSlash(path: string): string

  • Makes sure the input path has exactly 1 slash at the end. Multiple slashes will get merged into one. If there is no slash it will be added.

    Parameters

    • path: string

      Path to check.

    Returns string

    The potentially changed path.

getExtension

  • getExtension(path: string): string

  • Extracts the extension (without dot) from a path. Custom function since path.extname does not work on all cases (e.g. ".acl")

    Parameters

    • path: string

      Input path to parse.

    Returns string

isContainerIdentifier

isContainerPath

  • isContainerPath(path: string): boolean

  • Checks if the path corresponds to a container path (ending in a /).

    Parameters

    • path: string

      Path to check.

    Returns boolean

joinFilePath

  • joinFilePath(basePath: string, ...paths: string[]): string

  • Adds the paths to the base path.

    Parameters

    • basePath: string

      The base path (POSIX or Windows).

    • Rest ...paths: string[]

      Subpaths to attach (POSIX).

    Returns string

    The potentially changed path (POSIX).

normalizeFilePath

  • normalizeFilePath(path: string): string

  • Resolves relative segments in the path.

    Parameters

    • path: string

      Path to check (POSIX or Windows).

    Returns string

    The potentially changed path (POSIX).

toCanonicalUriPath

  • toCanonicalUriPath(path: string): string

  • Converts a URI path to the canonical version by splitting on slashes, decoding any percent-based encodings, and then encoding any special characters.

    Parameters

    • path: string

    Returns string

trimTrailingSlashes

  • trimTrailingSlashes(path: string): string

  • Makes sure the input path has no slashes at the end.

    Parameters

    • path: string

      Path to check.

    Returns string

    The potentially changed path.