www.aleph1.co.uk Git - yaffs-website/blob - node_modules/path-root-regex/README.md

   1 # path-root-regex [![NPM version](https://img.shields.io/npm/v/path-root-regex.svg?style=flat)](https://www.npmjs.com/package/path-root-regex) [![NPM downloads](https://img.shields.io/npm/dm/path-root-regex.svg?style=flat)](https://npmjs.org/package/path-root-regex) [![Build Status](https://img.shields.io/travis/regexhq/path-root-regex.svg?style=flat)](https://travis-ci.org/regexhq/path-root-regex)
   2
   3 > Regular expression for getting the root of a posix or windows filepath.
   4
   5 You might also be interested in [path-root](https://github.com/jonschlinkert/path-root).
   6
   7 ## Usage
   8
   9 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);
  10
  11 ```js
  12 var pathRootRegex = require('path-root-regex');
  13
  14 console.log(pathRootRegex() instanceof RegExp);
  15 //=> true
  16 ```
  17
  18 See the [path-root](https://github.com/jonschlinkert/path-root) module for examples.
  19
  20 ## Related projects
  21
  22 You might also be interested in these projects:
  23
  24 * [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)
  25 * [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)
  26
  27 ## Contributing
  28
  29 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).
  30
  31 ## Running tests
  32
  33 Install dev dependencies:
  34
  35 ```sh
  36 $ npm install -d && npm test
  37 ```
  38
  39 ## Author
  40
  41 **Jon Schlinkert**
  42
  43 * [github/jonschlinkert](https://github.com/jonschlinkert)
  44 * [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
  45
  46 ## License
  47
  48 Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).
  49 Released under the [MIT license](https://github.com/regexhq/path-root-regex/blob/master/LICENSE).
  50
  51 ***
  52
  53 _This file was generated by [verb](https://github.com/verbose/verb), v, on March 29, 2016._