Back to Pocketbase

Function clean

static/jsvm/functions/_filepath.clean.html

latest1.5 KB
Original Source

Function clean

  • clean(path): string

Clean returns the shortest path name equivalent to path by purely lexical processing. It applies the following rules iteratively until no further processing can be done:

  1. Replace multiple [Separator] elements with a single one.
  2. Eliminate each . path name element (the current directory).
  3. Eliminate each inner .. path name element (the parent directory)
along with the non-.. element that precedes it.Copy
  1. Eliminate .. elements that begin a rooted path:
that is, replace "/.." by "/" at the beginning of a path, assuming Separator is '/'.Copy

The returned path ends in a slash only if it represents a root directory, such as "/" on Unix or C:\ on Windows.

Finally, any occurrences of slash are replaced by Separator.

If the result of this process is an empty string, Clean returns the string ".".

On Windows, Clean does not modify the volume name other than to replace occurrences of "/" with ``. For example, Clean("//host/share/../x") returns \\host\share\x.

See also Rob Pike, “Lexical File Names in Plan 9 or Getting Dot-Dot Right,” https://9p.io/sys/doc/lexnames.html

Parameters

path: string

Returns string

Settings

Member Visibility

  • Inherited

Theme

OSLightDark

Generated using TypeDoc