JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 1487
  • Score
    100M100P100Q117338F
  • License MIT

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

Package Exports

    Readme

    Visulima path

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


    [typescript-image][typescript-url] [![npm-image]][npm-url] [![license-image]][license-url]


    Daniel Bannert's open source work is supported by the community on GitHub Sponsors


    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, pathe is providing identical exports of Node.js with normalization on all operations and written in modern ESM/Typescript and has no dependency on Node.js!

    Install

    npm install @visulima/path
    yarn add @visulima/path
    pnpm add @visulima/path

    Usage

    // ESM / Typescript
    import { resolve } from "@visulima/path";
    // or
    import path from "@visulima/path";
    
    // CommonJS
    const { resolve } = require("@visulima/path");
    // or
    const path = require("@visulima/path");

    Check https://nodejs.org/api/path.html about the exported functions. Note: path.win32 and path.posix are not exported.

    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 } from "@visulima/path/utils";
    
    // CommonJS
    const { filename, normalizeAliases, resolveAlias, reverseResolveAlias, isRelative, isBinaryPath, toPath } = require("@visulima/path/utils");
    • 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

    License

    The visulima path is open-sourced software licensed under the [MIT][license-url]

    [typescript-url]: https://www.typescriptlang.org/ "TypeScript" "typescript" [license-image]: https://img.shields.io/npm/l/@visulima/path?color=blueviolet&style=for-the-badge [license-url]: LICENSE.md "license" [npm-image]: https://img.shields.io/npm/v/@visulima/path/latest.svg?style=for-the-badge&logo=npm [npm-url]: https://www.npmjs.com/package/@visulima/path/v/latest "npm"