std/path/mod.ts
Asher Gomez d8592d1892
docs(path): add examples to @std/path/posix examples (#5371)
* docs(path): add examples to `@std/path/posix` examples

* work
2024-07-24 16:14:56 +10:00

59 lines
1.8 KiB
TypeScript

// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
// Copyright the Browserify authors. MIT License.
// Ported mostly from https://github.com/browserify/path-browserify/
// This module is browser compatible.
/**
* Utilities for working with OS-specific file paths.
*
* Functions from this module will automatically switch to support the path style
* of the current OS, either `windows` for Microsoft Windows, or `posix` for
* every other operating system, eg. Linux, MacOS, BSD etc.
*
* To use functions for a specific path style regardless of the current OS
* import the modules from the platform sub directory instead.
*
* Example, for POSIX:
*
* ```ts
* import { fromFileUrl } from "@std/path/posix/from-file-url";
* import { assertEquals } from "@std/assert";
*
* assertEquals(fromFileUrl("file:///home/foo"), "/home/foo");
* ```
*
* Or, for Windows:
*
* ```ts
* import { fromFileUrl } from "@std/path/windows/from-file-url";
* import { assertEquals } from "@std/assert";
*
* assertEquals(fromFileUrl("file:///home/foo"), "\\home\\foo");
* ```
*
* Functions for working with URLs can be found in
* {@link ./doc/posix/~ | @std/path/posix}.
*
* @module
*/
export * from "./basename.ts";
export * from "./constants.ts";
export * from "./dirname.ts";
export * from "./extname.ts";
export * from "./format.ts";
export * from "./from_file_url.ts";
export * from "./is_absolute.ts";
export * from "./join.ts";
export * from "./normalize.ts";
export * from "./parse.ts";
export * from "./relative.ts";
export * from "./resolve.ts";
export * from "./to_file_url.ts";
export * from "./to_namespaced_path.ts";
export * from "./common.ts";
export * from "./types.ts";
export * from "./glob_to_regexp.ts";
export * from "./is_glob.ts";
export * from "./join_globs.ts";
export * from "./normalize_glob.ts";