bare-path

stable

bare-path — Path manipulation library for JavaScript. It is a native addon.

Mirrors the Node.js path module.

npm i bare-path

Usage

const path = require('bare-path')

path.join('foo', 'bar') // foo/bar on posix, foo\bar on windows

API

Joining and resolving

`path.join(...paths: string[]): string`

_Source

Joins all given path segments using the platform-specific separator, then normalizes the result.

Parameters

Parameter	Type	Default	Description
`paths`	`string[]`	—	The path segments to join together, in the order given.

Throws

TypeError — thrown if any path segment is not a string.

`path.resolve(...args: string[]): string`

_Source

Resolves a sequence of paths or path segments into an absolute path.

Parameters

Parameter	Type	Default	Description
`args`	`string[]`	—	The path segments to resolve, processed from right to left until an absolute path is constructed.

Returns string — Falls back to the current working directory (or that of the resolved drive, on Windows) if none of the given segments is absolute.

Throws

TypeError — thrown if any path segment is not a string.

`path.normalize(path: string): string`

_Source

Normalizes path, resolving . and .. segments.

Parameters

Parameter	Type	Default	Description
`path`	`string`	—	The path to normalize.

Throws

TypeError — thrown if path is not a string.

`path.relative(from: string, to: string): string`

_Source

Returns the relative path from from to to.

Parameters

Parameter	Type	Default	Description
`from`	`string`	—	The path to resolve the relative path from.
`to`	`string`	—	The path to resolve the relative path to.

Returns string — Both from and to are resolved to absolute paths before comparing, and an empty string is returned if they resolve to the same path.

Throws

TypeError — thrown if from or to is not a string.

Inspecting paths

`path.basename(path: string, suffix?: string): string`

_Source

Returns the last portion of path, similar to the Unix basename command.

Parameters

Parameter	Type	Default	Description
`path`	`string`	—	The path to extract the last portion from.
`suffix?`	`string`	—	An optional suffix to remove from the end of the result, if it matches exactly.

Returns string — An empty string if suffix equals path exactly.

Throws

TypeError — thrown if path, or a defined suffix, is not a string.

`path.dirname(path: string): string`

_Source

Returns the directory name of path, similar to the Unix dirname command.

Parameters

Parameter	Type	Default	Description
`path`	`string`	—	The path to extract the directory name from.

Throws

TypeError — thrown if path is not a string.

`path.extname(path: string): string`

_Source

Returns the extension of path, from the last . to the end of the string.

Parameters

Parameter	Type	Default	Description
`path`	`string`	—	The path to extract the extension from.

Returns string — An empty string if path has no . in its last segment, or if that segment's only . is its first character (e.g. a dotfile).

Throws

TypeError — thrown if path is not a string.

`path.isAbsolute(path: string): boolean`

_Source

Returns true if path is an absolute path.

Parameters

Parameter	Type	Default	Description
`path`	`string`	—	The path to test.

Returns boolean — On Windows, a drive-qualified path such as C:\foo is also absolute; on POSIX, only paths starting with / are absolute.

Throws

TypeError — thrown if path is not a string.

`path.toNamespacedPath(path: string): string`

_Source

Converts path to a namespace-prefixed path on Windows; returns path unchanged on POSIX.

Parameters

Parameter	Type	Default	Description
`path`	`string`	—	The path to convert.

Returns string — On Windows, resolves path and prefixes UNC paths with \\?\UNC\ and drive-letter paths with \\?\; other paths (including non-string input) are returned unchanged.

bare-path

Usage

API

Joining and resolving

`path.join(...paths: string[]): string`

`path.resolve(...args: string[]): string`

`path.normalize(path: string): string`

`path.relative(from: string, to: string): string`

Inspecting paths

`path.basename(path: string, suffix?: string): string`

`path.dirname(path: string): string`

`path.extname(path: string): string`

`path.isAbsolute(path: string): boolean`

`path.toNamespacedPath(path: string): string`

Platform variants and separators

`path.sep: '/' | '\\'`

`path.delimiter: ':' | ';'`

`path.posix`

`path.win32`

See also

On this page