blob: aa3c86166081e49876c58e552df7278fc7d84a0f (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
|
# path-root [](https://www.npmjs.com/package/path-root) [](https://npmjs.org/package/path-root) [](https://travis-ci.org/jonschlinkert/path-root)
> Get the root of a posix or windows filepath.
You might also be interested in [parse-filepath](https://github.com/jonschlinkert/parse-filepath).
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install path-root --save
```
## Usage
```js
var pathRoot = require('path-root');
```
**Examples**
```js
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](https://www.npmjs.com/package/is-absolute): Polyfill for node.js `path.isAbolute`. Returns true if a file path is absolute. | [homepage](https://github.com/jonschlinkert/is-absolute)
* [parse-filepath](https://www.npmjs.com/package/parse-filepath): Parse a filepath into an object. Falls back on the native node.js `path.parse` method if… [more](https://www.npmjs.com/package/parse-filepath) | [homepage](https://github.com/jonschlinkert/parse-filepath)
* [path-root-regex](https://www.npmjs.com/package/path-root-regex): Regular expression for getting the root of a posix or windows filepath. | [homepage](https://github.com/regexhq/path-root-regex)
## Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/path-root/issues/new).
## Building docs
Generate readme and API documentation with [verb](https://github.com/verbose/verb):
```sh
$ npm install verb && npm run docs
```
Or, if [verb](https://github.com/verbose/verb) is installed globally:
```sh
$ verb
```
## Running tests
Install dev dependencies:
```sh
$ npm install -d && npm test
```
## Author
**Jon Schlinkert**
* [github/jonschlinkert](https://github.com/jonschlinkert)
* [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
## License
Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT license](https://github.com/jonschlinkert/path-root/blob/master/LICENSE).
***
_This file was generated by [verb](https://github.com/verbose/verb), v, on March 29, 2016._
|
