diff options
Diffstat (limited to 'node_modules/path-root-regex/README.md')
| -rw-r--r-- | node_modules/path-root-regex/README.md | 53 |
1 files changed, 53 insertions, 0 deletions
diff --git a/node_modules/path-root-regex/README.md b/node_modules/path-root-regex/README.md new file mode 100644 index 000000000..9cc61ec9a --- /dev/null +++ b/node_modules/path-root-regex/README.md @@ -0,0 +1,53 @@ +# path-root-regex [](https://www.npmjs.com/package/path-root-regex) [](https://npmjs.org/package/path-root-regex) [](https://travis-ci.org/regexhq/path-root-regex) + +> Regular expression for getting the root of a posix or windows filepath. + +You might also be interested in [path-root](https://github.com/jonschlinkert/path-root). + +## Usage + +The module exposes a function that must be called to get the regex (modified from the split device regex in the node.js path module); + +```js +var pathRootRegex = require('path-root-regex'); + +console.log(pathRootRegex() instanceof RegExp); +//=> true +``` + +See the [path-root](https://github.com/jonschlinkert/path-root) module for examples. + +## 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) + +## Contributing + +Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/path-root-regex/issues/new). + +## 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/regexhq/path-root-regex/blob/master/LICENSE). + +*** + +_This file was generated by [verb](https://github.com/verbose/verb), v, on March 29, 2016._
\ No newline at end of file |