@visulima/path

Drop-in replacement of the Node.js path module.

---

---

Why

For historical reasons, windows followed MS-DOS and using backslash for separating paths rather than slash used for macOS, Linux, and other Posix operating systems. Nowadays, Windows supports both Slash and Backslash for paths. Node.js's built in path module in the default operation of the path module varies based on the operating system on which a Node.js application is running. Specifically, when running on a Windows operating system, the path module will assume that Windows-style paths are being used. This makes inconsistent code behavior between Windows and POSIX.

Compared to popular upath, @visulima/path provides identical exports to Node.js with normalization on all operations, is written in modern ESM/TypeScript, and has no runtime dependencies!

Install

npm install @visulima/path

yarn add @visulima/path

pnpm add @visulima/path

Usage

This package is ESM-only ("type": "module"). Import it with import:

// ESM / TypeScript
import { resolve } from "@visulima/path";
// or
import path from "@visulima/path";

Check https://nodejs.org/api/path.html about the exported functions. Note: path.win32 and path.posix are both exported, but they are aliased to the same POSIX implementation — they exist only so that import path from "@visulima/path" works as a drop-in node:path shim. Do not rely on path.win32 for Windows-style (backslash) output; every operation is normalized to POSIX.

Extra utilities

@visulima/path exports some extra utilities that do not exist in standard Node.js path module. In order to use them, you can import from @visulima/path/utils subpath:

// ESM / TypeScript
import { filename, normalizeAliases, resolveAlias, reverseResolveAlias, isRelative, isBinaryPath, toPath, isWindows } from "@visulima/path/utils";

Related

• upath - A proxy to path, replacing \ with / for all results & methods to add, change, default, trim file extensions.
• pathe - Drop-in replacement of the Node.js's path module, module that ensures paths are normalized.

Supported Node.js Versions

Libraries in this ecosystem make the best effort to track Node.js’ release schedule. Here’s a post on why we think this is important.

Contributing

If you would like to help take a look at the list of issues and check our Contributing guidelines.

Note: please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Credits

• Daniel Bannert
• All Contributors

Made with at Anolilab

This is an open source project and will always remain free to use. If you think it's cool, please star it . Anolilab is a Development and AI Studio. Contact us at hello@anolilab.com if you need any help with these technologies or just want to say hi!

License

The visulima path is open-sourced software licensed under the MIT