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

   1 # path-parse [![Build Status](https://travis-ci.org/jbgutierrez/path-parse.svg?branch=master)](https://travis-ci.org/jbgutierrez/path-parse)
   2
   3 > Node.js [`path.parse(pathString)`](https://nodejs.org/api/path.html#path_path_parse_pathstring) ponyfill.
   4
   5 > Ponyfill: A polyfill that doesn't overwrite the native method
   6
   7 ## Install
   8
   9 ```
  10 $ npm install --save path-parse
  11 ```
  12
  13 ## Usage
  14
  15 ```js
  16 var pathParse = require('path-parse');
  17
  18 pathParse('/home/user/dir/file.txt');
  19 //=> {
  20 //       root : "/",
  21 //       dir : "/home/user/dir",
  22 //       base : "file.txt",
  23 //       ext : ".txt",
  24 //       name : "file"
  25 //   }
  26 ```
  27
  28 ## API
  29
  30 See [`path.parse(pathString)`](https://nodejs.org/api/path.html#path_path_parse_pathstring) docs.
  31
  32 ### pathParse(path)
  33
  34 ### pathParse.posix(path)
  35
  36 The Posix specific version.
  37
  38 ### pathParse.win32(path)
  39
  40 The Windows specific version.
  41
  42 ## License
  43
  44 MIT © [Javier Blanco](http://jbgutierrez.info)