// Copyright 2018-2025 the Deno authors. MIT license.
// This module is browser compatible.
import { isWindows } from "./_os.ts";
import type { ParsedPath } from "./types.ts";
import { parse as posixParse } from "./posix/parse.ts";
import { parse as windowsParse } from "./windows/parse.ts";
export type { ParsedPath } from "./types.ts";
/**
* Return an object containing the parsed components of the path.
*
* Use {@linkcode https://jsr.io/@std/path/doc/~/format | format()} to reverse
* the result.
*
* @example Usage
* ```ts
* import { parse } from "@std/path/parse";
* import { assertEquals } from "@std/assert";
*
* if (Deno.build.os === "windows") {
* const parsedPathObj = parse("C:\\path\\to\\script.ts");
* assertEquals(parsedPathObj.root, "C:\\");
* assertEquals(parsedPathObj.dir, "C:\\path\\to");
* assertEquals(parsedPathObj.base, "script.ts");
* assertEquals(parsedPathObj.ext, ".ts");
* assertEquals(parsedPathObj.name, "script");
* } else {
* const parsedPathObj = parse("/path/to/dir/script.ts");
* parsedPathObj.root; // "/"
* parsedPathObj.dir; // "/path/to/dir"
* parsedPathObj.base; // "script.ts"
* parsedPathObj.ext; // ".ts"
* parsedPathObj.name; // "script"
* }
* ```
*
* @param path Path to process
* @returns An object with the parsed path components.
*/
export function parse(path: string): ParsedPath {
return isWindows ? windowsParse(path) : posixParse(path);
}
|