/**
|
* 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/v25.x/lib/path.js)
|
*/
|
declare module "node: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;
|
}
|
/**
|
* 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. If the path is a zero-length string, '.' is returned, representing the current working directory.
|
*
|
* @param path string path to normalize.
|
* @throws {TypeError} if `path` is not a string.
|
*/
|
function 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.
|
*/
|
function 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.
|
*/
|
function 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
|
*/
|
function 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.
|
*/
|
function 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.
|
*/
|
function 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.
|
*/
|
function 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.
|
*/
|
function 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.
|
*/
|
function extname(path: string): string;
|
/**
|
* The platform-specific file separator. '\\' or '/'.
|
*/
|
const sep: "\\" | "/";
|
/**
|
* The platform-specific file delimiter. ';' or ':'.
|
*/
|
const 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.
|
*/
|
function parse(path: string): ParsedPath;
|
/**
|
* Returns a path string from an object - the opposite of parse().
|
*
|
* @param pathObject path to evaluate.
|
*/
|
function 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.
|
*/
|
function toNamespacedPath(path: string): string;
|
}
|
namespace path {
|
export {
|
/**
|
* The `path.posix` property provides access to POSIX specific implementations of the `path` methods.
|
*
|
* The API is accessible via `require('node:path').posix` or `require('node:path/posix')`.
|
*/
|
path as posix,
|
/**
|
* The `path.win32` property provides access to Windows-specific implementations of the `path` methods.
|
*
|
* The API is accessible via `require('node:path').win32` or `require('node:path/win32')`.
|
*/
|
path as win32,
|
};
|
}
|
export = path;
|
}
|
declare module "path" {
|
import path = require("node:path");
|
export = path;
|
}
|
