mirror of
https://github.com/denoland/std.git
synced 2024-11-22 04:59:05 +00:00
30 lines
1.1 KiB
TypeScript
30 lines
1.1 KiB
TypeScript
// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
|
|
// This module is browser compatible.
|
|
|
|
import { normalize as stableNormalize } from "./normalize.ts";
|
|
import { fromFileUrl } from "./from_file_url.ts";
|
|
|
|
/**
|
|
* 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 `'.'`.
|
|
*
|
|
* @experimental **UNSTABLE**: New API, yet to be vetted.
|
|
*
|
|
* @example Usage
|
|
* ```ts
|
|
* import { normalize } from "@std/path/posix/unstable-normalize";
|
|
* import { assertEquals } from "@std/assert";
|
|
*
|
|
* assertEquals(normalize("/foo/bar//baz/asdf/quux/.."), "/foo/bar/baz/asdf");
|
|
* assertEquals(normalize(new URL("file:///foo/bar//baz/asdf/quux/..")), "/foo/bar/baz/asdf/");
|
|
* ```
|
|
*
|
|
* @param path The path to normalize. Path can be a string or a file URL object.
|
|
* @returns The normalized path.
|
|
*/
|
|
export function normalize(path: string | URL): string {
|
|
path = path instanceof URL ? fromFileUrl(path) : path;
|
|
return stableNormalize(path);
|
|
}
|