nsq/nsqadmin/node_modules/parse-filepath

parse-filepath

Pollyfill for node.js path.parse, parses a filepath into an object.

You might also be interested in global-prefix.

Install

Install with npm:

$ npm install parse-filepath --save

Usage

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

var parsePath = require('parse-filepath');
console.log(parsePath('foo/bar/baz/index.js'));

Returns:

{ 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: Get the npm global path prefix. | homepage
• is-absolute: Polyfill for node.js path.isAbolute. Returns true if a file path is absolute. | homepage
• is-relative: Returns true if the path appears to be relative. | homepage
• relative: Get the relative filepath from path A to path B. Calculates from file-to-directory, file-to-file, directory-to-file,… more | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Building docs

Generate readme and API documentation with verb:

$ npm install verb && npm run docs

Or, if verb is installed globally:

$ verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2016, Jon Schlinkert. Released under the MIT license.

---

This file was generated by verb, v, on March 29, 2016.