Module util/PathUtil

Index

Functions

Functions

decodeUriPathComponents

decodeUriPathComponents(path: string): string

- Defined in src/util/PathUtil.ts:86
Decodes all components of a URI path.

Parameters
- path: string
Returns string

encodeUriPathComponents

encodeUriPathComponents(path: string): string

- Defined in src/util/PathUtil.ts:93
Encodes all (non-slash) special characters in a URI path.

Parameters
- path: string
Returns string

ensureTrailingSlash

ensureTrailingSlash(path: string): string

- Defined in src/util/PathUtil.ts:58
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.

isContainerIdentifier

isContainerIdentifier(identifier: ResourceIdentifier): boolean

- Defined in src/util/PathUtil.ts:109
Checks if the identifier corresponds to a container identifier.

Parameters
- identifier: ResourceIdentifier
  
  Identifier to check.
Returns boolean

isContainerPath

isContainerPath(path: string): boolean

- Defined in src/util/PathUtil.ts:101
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

- Defined in src/util/PathUtil.ts:34
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

- Defined in src/util/PathUtil.ts:22
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

- Defined in src/util/PathUtil.ts:78
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

toSystemFilePath

toSystemFilePath(path: string): string

- Defined in src/util/PathUtil.ts:45
Converts the path into an OS-dependent path.

Parameters
- path: string
  
  Path to check (POSIX).
Returns string

The potentially changed path (OS-dependent).

trimTrailingSlashes

trimTrailingSlashes(path: string): string

- Defined in src/util/PathUtil.ts:69
Makes sure the input path has no slashes at the end.

Parameters
- path: string
  
  Path to check.
Returns string

The potentially changed path.