123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200 |
- declare module "path/posix" {
- import path = require("path");
- export = path;
- }
- declare module "path/win32" {
- import path = require("path");
- export = path;
- }
- /**
- * The `node:path` module provides utilities for working with file and directory
- * paths. It can be accessed using:
- *
- * ```js
- * import path from 'node:path';
- * ```
- * @see [source](https://github.com/nodejs/node/blob/v22.x/lib/path.js)
- */
- declare module "path" {
- namespace path {
- /**
- * A parsed path object generated by path.parse() or consumed by path.format().
- */
- interface ParsedPath {
- /**
- * The root of the path such as '/' or 'c:\'
- */
- root: string;
- /**
- * The full directory path such as '/home/user/dir' or 'c:\path\dir'
- */
- dir: string;
- /**
- * The file name including extension (if any) such as 'index.html'
- */
- base: string;
- /**
- * The file extension (if any) such as '.html'
- */
- ext: string;
- /**
- * The file name without extension (if any) such as 'index'
- */
- name: string;
- }
- interface FormatInputPathObject {
- /**
- * The root of the path such as '/' or 'c:\'
- */
- root?: string | undefined;
- /**
- * The full directory path such as '/home/user/dir' or 'c:\path\dir'
- */
- dir?: string | undefined;
- /**
- * The file name including extension (if any) such as 'index.html'
- */
- base?: string | undefined;
- /**
- * The file extension (if any) such as '.html'
- */
- ext?: string | undefined;
- /**
- * The file name without extension (if any) such as 'index'
- */
- name?: string | undefined;
- }
- interface PlatformPath {
- /**
- * Normalize a string path, reducing '..' and '.' parts.
- * When multiple slashes are found, they're replaced by a single one; when the path contains a trailing slash, it is preserved. On Windows backslashes are used.
- *
- * @param path string path to normalize.
- * @throws {TypeError} if `path` is not a string.
- */
- normalize(path: string): string;
- /**
- * Join all arguments together and normalize the resulting path.
- *
- * @param paths paths to join.
- * @throws {TypeError} if any of the path segments is not a string.
- */
- join(...paths: string[]): string;
- /**
- * The right-most parameter is considered {to}. Other parameters are considered an array of {from}.
- *
- * Starting from leftmost {from} parameter, resolves {to} to an absolute path.
- *
- * If {to} isn't already absolute, {from} arguments are prepended in right to left order,
- * until an absolute path is found. If after using all {from} paths still no absolute path is found,
- * the current working directory is used as well. The resulting path is normalized,
- * and trailing slashes are removed unless the path gets resolved to the root directory.
- *
- * @param paths A sequence of paths or path segments.
- * @throws {TypeError} if any of the arguments is not a string.
- */
- resolve(...paths: string[]): string;
- /**
- * The `path.matchesGlob()` method determines if `path` matches the `pattern`.
- * @param path The path to glob-match against.
- * @param pattern The glob to check the path against.
- * @returns Whether or not the `path` matched the `pattern`.
- * @throws {TypeError} if `path` or `pattern` are not strings.
- * @since v22.5.0
- */
- matchesGlob(path: string, pattern: string): boolean;
- /**
- * Determines whether {path} is an absolute path. An absolute path will always resolve to the same location, regardless of the working directory.
- *
- * If the given {path} is a zero-length string, `false` will be returned.
- *
- * @param path path to test.
- * @throws {TypeError} if `path` is not a string.
- */
- isAbsolute(path: string): boolean;
- /**
- * Solve the relative path from {from} to {to} based on the current working directory.
- * At times we have two absolute paths, and we need to derive the relative path from one to the other. This is actually the reverse transform of path.resolve.
- *
- * @throws {TypeError} if either `from` or `to` is not a string.
- */
- relative(from: string, to: string): string;
- /**
- * Return the directory name of a path. Similar to the Unix dirname command.
- *
- * @param path the path to evaluate.
- * @throws {TypeError} if `path` is not a string.
- */
- dirname(path: string): string;
- /**
- * Return the last portion of a path. Similar to the Unix basename command.
- * Often used to extract the file name from a fully qualified path.
- *
- * @param path the path to evaluate.
- * @param suffix optionally, an extension to remove from the result.
- * @throws {TypeError} if `path` is not a string or if `ext` is given and is not a string.
- */
- basename(path: string, suffix?: string): string;
- /**
- * Return the extension of the path, from the last '.' to end of string in the last portion of the path.
- * If there is no '.' in the last portion of the path or the first character of it is '.', then it returns an empty string.
- *
- * @param path the path to evaluate.
- * @throws {TypeError} if `path` is not a string.
- */
- extname(path: string): string;
- /**
- * The platform-specific file separator. '\\' or '/'.
- */
- readonly sep: "\\" | "/";
- /**
- * The platform-specific file delimiter. ';' or ':'.
- */
- readonly delimiter: ";" | ":";
- /**
- * Returns an object from a path string - the opposite of format().
- *
- * @param path path to evaluate.
- * @throws {TypeError} if `path` is not a string.
- */
- parse(path: string): ParsedPath;
- /**
- * Returns a path string from an object - the opposite of parse().
- *
- * @param pathObject path to evaluate.
- */
- format(pathObject: FormatInputPathObject): string;
- /**
- * On Windows systems only, returns an equivalent namespace-prefixed path for the given path.
- * If path is not a string, path will be returned without modifications.
- * This method is meaningful only on Windows system.
- * On POSIX systems, the method is non-operational and always returns path without modifications.
- */
- toNamespacedPath(path: string): string;
- /**
- * Posix specific pathing.
- * Same as parent object on posix.
- */
- readonly posix: PlatformPath;
- /**
- * Windows specific pathing.
- * Same as parent object on windows
- */
- readonly win32: PlatformPath;
- }
- }
- const path: path.PlatformPath;
- export = path;
- }
- declare module "node:path" {
- import path = require("path");
- export = path;
- }
- declare module "node:path/posix" {
- import path = require("path/posix");
- export = path;
- }
- declare module "node:path/win32" {
- import path = require("path/win32");
- export = path;
- }
|