/deps/path.ts | lume@v1.19.0

import * as lume from "https://deno.land/x/lume@v1.19.0/deps/path.ts";

Utilities for working with OS-specific file paths.

Codes in the examples uses POSIX path but it automatically use Windows path on Windows. Use methods under posix or win32 object instead to handle non platform specific path like:

import { posix, win32 } from "https://deno.land/std@0.224.0/path/mod.ts";
const p1 = posix.fromFileUrl("file:///home/foo");
const p2 = win32.fromFileUrl("file:///home/foo");
console.log(p1); // "/home/foo"
console.log(p2); // "\\home\\foo"

This module is browser compatible.

Variables

v delimiter
v posix
v SEP
v SEP_PATTERN
v win32

Functions

f basename	Return the last portion of a `path`. Trailing directory separators are ignored, and optional suffix is removed.
f common	Determines the common path from a set of paths, using an optional separator, which defaults to the OS default separator.
f dirname	Return the directory path of a `path`.
f extname	Return the extension of the `path` with leading period.
f format	Generate a path from `FormatInputPathObject` object.
f fromFileUrl	Converts a file URL to a path string.
f globToRegExp	Convert a glob string to a regular expression.
f isAbsolute	Verifies whether provided path is absolute
f isGlob	Test whether the given string is a glob
f join	Join all given a sequence of `paths`,then normalizes the resulting path.
f joinGlobs	Like join(), but doesn't collapse "**/.." when `globstar` is true.
f normalize	Normalize the `path`, resolving `'..'` and `'.'` segments. Note that resolving these segments does not necessarily mean that all will be eliminated. A `'..'` at the top-level will be preserved, and an empty path is canonically `'.'`.
f normalizeGlob	Like normalize(), but doesn't collapse "**/.." when `globstar` is true.
f parse	Return a `ParsedPath` object of the `path`.
f relative	Return the relative path from `from` to `to` based on current working directory.
f resolve	Resolves path segments into a `path`
f toFileUrl	Converts a path string to a file URL.
f toNamespacedPath	Resolves path to a namespace path

Interfaces

I GlobOptions
I ParsedPath	A parsed path object generated by path.parse() or consumed by path.format().

Type Aliases

T FormatInputPathObject
T GlobToRegExpOptions