mirror of
https://github.com/denoland/std.git
synced 2024-11-22 04:59:05 +00:00
44 lines
1.4 KiB
TypeScript
44 lines
1.4 KiB
TypeScript
// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
|
|
// This module is browser compatible.
|
|
|
|
import { assertPath } from "../_common/assert_path.ts";
|
|
import { normalize } from "./normalize.ts";
|
|
|
|
/**
|
|
* Join all given a sequence of `paths`,then normalizes the resulting path.
|
|
*
|
|
* @example Usage
|
|
* ```ts
|
|
* import { join } from "@std/path/posix/join";
|
|
* import { assertEquals } from "@std/assert";
|
|
*
|
|
* const path = join("/foo", "bar", "baz/asdf", "quux", "..");
|
|
* assertEquals(path, "/foo/bar/baz/asdf");
|
|
* ```
|
|
*
|
|
* @example Working with URLs
|
|
* ```ts
|
|
* import { join } from "@std/path/posix/join";
|
|
* import { assertEquals } from "@std/assert";
|
|
*
|
|
* const url = new URL("https://deno.land");
|
|
* url.pathname = join("std", "path", "mod.ts");
|
|
* assertEquals(url.href, "https://deno.land/std/path/mod.ts");
|
|
*
|
|
* url.pathname = join("//std", "path/", "/mod.ts");
|
|
* assertEquals(url.href, "https://deno.land/std/path/mod.ts");
|
|
* ```
|
|
*
|
|
* Note: If you are working with file URLs,
|
|
* use the new version of `join` from `@std/path/posix/unstable-join`.
|
|
*
|
|
* @param paths The paths to join.
|
|
* @returns The joined path.
|
|
*/
|
|
export function join(...paths: string[]): string {
|
|
if (paths.length === 0) return ".";
|
|
paths.forEach((path) => assertPath(path));
|
|
const joined = paths.filter((path) => path.length > 0).join("/");
|
|
return joined === "" ? "." : normalize(joined);
|
|
}
|