typedoc
Version:
Create api documentation for TypeScript projects.
36 lines (35 loc) • 1.25 kB
TypeScript
/**
* Represents a normalized path with path separators being `/`
* On Windows, drives are represented like `C:/Users` for consistency
* with TypeScript.
*
* The empty string `""` is a valid normalized path.
*/
export type NormalizedPath = "" | "/" | string & {
readonly __normPath: unique symbol;
};
/**
* Represents either a {@link NormalizedPath} or a Node module name
* (e.g. `typedoc-plugin-mdn-links` or `@gerrit0/typedoc-plugin`)
*/
export type NormalizedPathOrModule = NormalizedPath | string & {
readonly __normPathOrModule: unique symbol;
};
/**
* Represents a glob path configured by a user.
*/
export type GlobString = string & {
readonly __globString: unique symbol;
};
export declare namespace NormalizedPathUtils {
function dirname(path: NormalizedPath): NormalizedPath;
function basename(path: NormalizedPath): NormalizedPath;
function relative(from: NormalizedPath, to: NormalizedPath): NormalizedPath;
function normalize(path: NormalizedPath): NormalizedPath;
function resolve(from: NormalizedPath, to: NormalizedPath): NormalizedPath;
function isAbsolute(from: NormalizedPath): boolean;
function splitFilename(name: string): {
name: string;
ext: string;
};
}