diff options
Diffstat (limited to 'node_modules/is-absolute/README.md')
| -rw-r--r-- | node_modules/is-absolute/README.md | 113 |
1 files changed, 113 insertions, 0 deletions
diff --git a/node_modules/is-absolute/README.md b/node_modules/is-absolute/README.md new file mode 100644 index 000000000..500f74f4f --- /dev/null +++ b/node_modules/is-absolute/README.md @@ -0,0 +1,113 @@ +# is-absolute [](https://www.npmjs.com/package/is-absolute) [](https://npmjs.org/package/is-absolute) [](https://travis-ci.org/jonschlinkert/is-absolute) + +> Polyfill for node.js `path.isAbolute`. Returns true if a file path is absolute. + +## Install + +Install with [npm](https://www.npmjs.com/): + +```sh +$ npm install --save is-absolute +``` + +Originally based on the `isAbsolute` utility method in [express](https://github.com/visionmedia/express). + +## Usage + +```js +var isAbsolute = require('is-absolute'); + +isAbsolute('a/b/c.js'); +//=> 'false' +isAbsolute('/a/b/c.js'); +//=> 'true' +``` + +**Explicitly test windows paths** + +```js +isAbsolute.posix('/foo/bar'); +isAbsolute.posix('/user/docs/Letter.txt'); +//=> true + +isAbsolute.posix('foo/bar'); +//=> false +``` + +**Explicitly test windows paths** + +```js +var isAbsolute = require('is-absolute'); + +isAbsolute.win32('c:\\'); +isAbsolute.win32('//C://user\\docs\\Letter.txt'); +isAbsolute.win32('\\\\unc\\share'); +isAbsolute.win32('\\\\unc\\share\\foo'); +isAbsolute.win32('\\\\unc\\share\\foo\\'); +isAbsolute.win32('\\\\unc\\share\\foo\\bar'); +isAbsolute.win32('\\\\unc\\share\\foo\\bar\\'); +isAbsolute.win32('\\\\unc\\share\\foo\\bar\\baz'); +//=> true + +isAbsolute.win32('a:foo/a/b/c/d'); +isAbsolute.win32(':\\'); +isAbsolute.win32('foo\\bar\\baz'); +isAbsolute.win32('foo\\bar\\baz\\'); +//=> false +``` + +## About + +### Related projects + +* [is-dotfile](https://www.npmjs.com/package/is-dotfile): Return true if a file path is (or has) a dotfile. Returns false if the… [more](https://github.com/jonschlinkert/is-dotfile) | [homepage](https://github.com/jonschlinkert/is-dotfile) +* [is-glob](https://www.npmjs.com/package/is-glob): Returns `true` if the given string looks like a glob pattern or an extglob pattern… [more](https://github.com/jonschlinkert/is-glob) | [homepage](https://github.com/jonschlinkert/is-glob) +* [is-relative](https://www.npmjs.com/package/is-relative): Returns `true` if the path appears to be relative. | [homepage](https://github.com/jonschlinkert/is-relative) +* [is-unc-path](https://www.npmjs.com/package/is-unc-path): Returns true if a filepath is a windows UNC file path. | [homepage](https://github.com/jonschlinkert/is-unc-path) +* [is-valid-glob](https://www.npmjs.com/package/is-valid-glob): Return true if a value is a valid glob pattern or patterns. | [homepage](https://github.com/jonschlinkert/is-valid-glob) + +### Contributing + +Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new). + +### Contributors + +| **Commits** | **Contributor**<br/> | +| --- | --- | +| 31 | [jonschlinkert](https://github.com/jonschlinkert) | +| 1 | [es128](https://github.com/es128) | +| 1 | [shinnn](https://github.com/shinnn) | + +### Building docs + +_(This document was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme) (a [verb](https://github.com/verbose/verb) generator), please don't edit the readme directly. Any changes to the readme must be made in [.verb.md](.verb.md).)_ + +To generate the readme and API documentation with [verb](https://github.com/verbose/verb): + +```sh +$ npm install -g verb verb-generate-readme && 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/is-absolute/blob/master/LICENSE). + +*** + +_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.1.31, on October 16, 2016._
\ No newline at end of file |