OLAS/node_modules/path-root/README.md

path-root

Get the root of a posix or windows filepath.

You might also be interested in parse-filepath.

Install

Install with npm:

$ npm install path-root --save

Usage

var pathRoot = require('path-root');

Examples

pathRoot('\\\\server\\share\\abc');
//=> '\\\\server\\share\\'

pathRoot('\\\\server foo\\some folder\\base-file.js');
//=> '\\\\server foo\\some folder\\'

pathRoot('\\\\?\\UNC\\server\\share');
//=> '\\\\?\\UNC\\'

pathRoot('foo/bar/baz.js');
//=> ''

pathRoot('c:\\foo\\bar\\baz.js');
//=> 'c:\\'

pathRoot('\\\\slslslsl\\admin$\\system32');
//=> '\\\\slslslsl\\admin$\\'

pathRoot('/foo/bar/baz.js');
//=> '/'

Related projects

You might also be interested in these projects:

• is-absolute: Polyfill for node.js path.isAbolute. Returns true if a file path is absolute. | homepage
• parse-filepath: Parse a filepath into an object. Falls back on the native node.js path.parse method if… more | homepage
• path-root-regex: Regular expression for getting the root of a posix or windows filepath. | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Building docs

Generate readme and API documentation with verb:

$ npm install verb && npm run docs

Or, if verb is installed globally:

$ verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2016, Jon Schlinkert. Released under the MIT license.

---

This file was generated by verb, v, on March 29, 2016.