@stackline/path-browserify
the path module from node core for browsers.
Documentation | npm | Issues | Repository
Current package version: 1.0.2
Why this package?
@stackline/path-browserify is the Stackline-maintained distribution of path-browserify@1.0.1. It is an independent continuation of path-browserify; original authors and licenses remain credited below.
Compatibility
| Item | Value |
|---|---|
| Package | @stackline/path-browserify@1.0.2 |
| API target | path-browserify@1.0.1 |
| Supported Node.js | See supported framework requirements |
| License | MIT |
| Main entry | index.js |
| Runtime dependencies | none |
Installation
npm install @stackline/path-browserify
Preserve existing imports and plugin resolution with an npm alias:
npm install path-browserify@npm:@stackline/path-browserify
Usage and API reference
path-browserify 
The
pathmodule from Node.js for browsers
This implements the Node.js path module for environments that do not have it, like browsers.
path-browserifycurrently matches the Node.js 10.3 API.
Install
You usually do not have to install path-browserify yourself! If your code runs in Node.js, path is built in. If your code runs in the browser, bundlers like browserify or webpack include the path-browserify module by default.
But if none of those apply, with npm do:
npm install @stackline/path-browserify
Usage
var path = require('path')
var filename = 'logo.png';
var logo = path.join('./assets/img', filename);
document.querySelector('#logo').src = logo;
API
See the Node.js path docs. path-browserify currently matches the Node.js 10.3 API.
path-browserify only implements the POSIX functions, not the win32 ones.
Contributing
PRs are very welcome! The main way to contribute to path-browserify is by porting features, bugfixes and tests from Node.js. Ideally, code contributions to this module are copy-pasted from Node.js and transpiled to ES5, rather than reimplemented from scratch. Matching the Node.js code as closely as possible makes maintenance simpler when new changes land in Node.js.
This module intends to provide exactly the same API as Node.js, so features that are not available in the core path module will not be accepted. Feature requests should instead be directed at nodejs/node and will be added to this module once they are implemented in Node.js.
If there is a difference in behaviour between Node.js's path module and this module, please open an issue!
License
Credits and original authors
- Original project: path-browserify.
- James Halliday.
- Copyright (c) 2013 James Halliday.
- Stackline maintenance: Alexandro Paixao Marques and Stackline contributors.
Original copyright, license notices and contributor acknowledgements remain part of this distribution. Stackline maintenance does not replace authorship of the original work.
Community and Links
Use this repository's issue tracker for reproducible bugs and feature requests. Join r/Stackline for examples, usage questions and release discussions.