std/path/join.ts
2024-09-12 19:41:45 +09:00

32 lines
1.0 KiB
TypeScript

// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
// This module is browser compatible.
import { isWindows } from "./_os.ts";
import { join as posixJoin } from "./posix/join.ts";
import { join as windowsJoin } from "./windows/join.ts";
/**
* Joins a sequence of paths, then normalizes the resulting path.
*
* @example Usage
* ```ts
* import { join } from "@std/path/join";
* import { assertEquals } from "@std/assert";
*
* if (Deno.build.os === "windows") {
* assertEquals(join("C:\\foo", "bar", "baz\\quux", "garply", ".."), "C:\\foo\\bar\\baz\\quux");
* } else {
* assertEquals(join("/foo", "bar", "baz/quux", "garply", ".."), "/foo/bar/baz/quux");
* }
* ```
*
* Note: If you are working with file URLs,
* use the new version of `join` from `@std/path/unstable-join`.
*
* @param paths Paths to be joined and normalized.
* @returns The joined and normalized path.
*/
export function join(...paths: string[]): string {
return isWindows ? windowsJoin(...paths) : posixJoin(...paths);
}