default

default: object

Type Declaration

Name	Type	Description
addExt()	(file, ext) => string	Adds .ext to filename, but only if it doesn't already have the exact extension.
basename()	(p, ext?) => 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.
changeExt()	(filename, ext, ignoreExts?, maxSize?) => string	Changes a filename's extension to ext. If it has no (valid) extension, it adds it. Valid extensions are considered to be up to maxSize chars long, counting the dot (defaults to 7). An Array of ignoreExts (eg ['.min']) prevents these from being considered as extension, thus are not changed - the new extension is added instead.
defaultExt()	(filename, ext, ignoreExts?, maxSize?) => string	Adds .ext to filename, only if it doesn't already have any old extension. (Old) extensions are considered to be up to maxSize chars long, counting the dot (defaults to 7). An Array of ignoreExts (eg ['.min']) will force adding default .ext even if one of these is present.
delimiter	string	‐
dirname()	(p) => string	Return the directory name of a path. Similar to the Unix dirname command.
extname()	(p) => 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
format()	(pathObject) => string	Returns a path string from an object - the opposite of parse().
isAbsolute()	(path) => boolean	Determines whether {path} is an absolute path. An absolute path will always resolve to the same location, regardless of the working directory.
join()	{(...paths): string; (...paths): string; }	Join all arguments together and normalize the resulting path. Arguments must be strings. In v0.8, non-string arguments were silently ignored. In v0.10 and up, an exception is thrown. Join all arguments together and normalize the resulting path. Arguments must be strings. In v0.8, non-string arguments were silently ignored. In v0.10 and up, an exception is thrown.
joinSafe()	(...paths) => string	Exactly like path.join(), but it keeps the first meaningful ./. Note that the unix / is returned everywhere, so windows \ is always converted to unix /.
normalize()	(p) => string	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.
normalizeSafe()	(p) => string	Exactly like path.normalize(path), but it keeps the first meaningful ./. Note that the unix / is returned everywhere, so windows \ is always converted to unix /.
normalizeTrim()	(p) => string	Exactly like path.normalizeSafe(path), but it trims any useless ending /.
parse()	(pathString) => ParsedPath	Returns an object from a path string - the opposite of format().
posix	typeof posix	‐
posixPath()	(pathname) => string	‐
relative()	(from, to) => string	Solve the relative path from {from} to {to}. 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.
removeExt()	(filename, ext) => string	Removes the specific ext extension from filename, if it has it. Otherwise it leaves it as is. As in all upath functions, it be .ext or ext.
resolve()	(...pathSegments) => 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.
sep	string	‐
toUnix()	(p) => string	Just converts all to/ and consolidates duplicates, without performing any normalization.
trimExt()	(filename, ignoreExts?, maxSize?) => string	Trims a filename's extension. Extensions are considered to be up to maxSize chars long, counting the dot (defaults to 7). An Array of ignoreExts (eg ['.min']) prevents these from being considered as extension, thus are not trimmed.
win32	typeof win32	‐
winPath()	(pathname) => string	‐