diff options
Diffstat (limited to 'node_modules/parse-filepath/README.md')
| -rw-r--r-- | node_modules/parse-filepath/README.md | 111 |
1 files changed, 111 insertions, 0 deletions
diff --git a/node_modules/parse-filepath/README.md b/node_modules/parse-filepath/README.md new file mode 100644 index 000000000..3eb7ce5d0 --- /dev/null +++ b/node_modules/parse-filepath/README.md @@ -0,0 +1,111 @@ +# parse-filepath [](https://www.npmjs.com/package/parse-filepath) [](https://npmjs.org/package/parse-filepath) [](https://travis-ci.org/jonschlinkert/parse-filepath) + +> Pollyfill for node.js `path.parse`, parses a filepath into an object. + +You might also be interested in [global-prefix](https://github.com/jonschlinkert/global-prefix). + +## Install + +Install with [npm](https://www.npmjs.com/): + +```sh +$ npm install parse-filepath --save +``` + +## Usage + +```js +var parsePath = require('parse-filepath'); +parsePath(filepath); +``` + +This can be used as a polyfill for the native node.js `path.parse()` method, and it also adds a few properties: + +* `path`: the original filepath +* `isAbsolute`: (getter) true if the given path is absolute +* `absolute`: (getter) fully resolved, absolute filepath +* `dirname`: alias for `dir` +* `basename`: alias for `base` +* `extname`: alias for `ext` +* `stem`: alias for `name` + +**Example** + +```js +var parsePath = require('parse-filepath'); +console.log(parsePath('foo/bar/baz/index.js')); +``` + +Returns: + +```js +{ root: '', + dir: 'foo/bar/baz', + base: 'index.js', + ext: '.js', + name: 'index', + + // aliases + extname: '.js', + basename: 'index.js', + dirname: 'foo/bar/baz', + stem: 'index', + + // original path + path: 'foo/bar/baz/index.js', + + // getters + absolute: [Getter/Setter], + isAbsolute: [Getter/Setter] } +``` + +## Related projects + +You might also be interested in these projects: + +* [global-prefix](https://www.npmjs.com/package/global-prefix): Get the npm global path prefix. | [homepage](https://github.com/jonschlinkert/global-prefix) +* [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) +* [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) +* [relative](https://www.npmjs.com/package/relative): Get the relative filepath from path A to path B. Calculates from file-to-directory, file-to-file, directory-to-file,… [more](https://www.npmjs.com/package/relative) | [homepage](https://github.com/jonschlinkert/relative) + +## Contributing + +Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/parse-filepath/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/parse-filepath/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 |