aboutsummaryrefslogtreecommitdiff
path: root/node_modules/path-dirname/readme.md
blob: 652a5623dfca72f6c7a35e09c3c99c41967a0590 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
# path-dirname [![Build Status](https://travis-ci.org/es128/path-dirname.svg?branch=master)](https://travis-ci.org/es128/path-dirname)

> Node.js [`path.dirname()`](https://nodejs.org/api/path.html#path_path_dirname_path) [ponyfill](https://ponyfill.com)

This was needed in order to expose `path.posix.dirname()` on Node.js v0.10

## Install

```
$ npm install --save path-dirname
```


## Usage

```js
const pathDirname = require('path-dirname');

pathDirname('/home/foo');
//=> '/home'
pathDirname('C:\\Users\\foo');
//=> 'C:\\Users'
pathDirname('foo');
//=> '.'
pathDirname('foo/bar');
//=> 'foo'

//Using posix version for consistent output when dealing with glob escape chars
pathDirname.win32('C:\\Users\\foo/\\*bar');
//=> 'C:\\Users\\foo/'
pathDirname.posix('C:\\Users\\foo/\\*bar');
//=> 'C:\\Users\\foo'
```


## API

See the [`path.dirname()` docs](https://nodejs.org/api/path.html#path_path_dirname_path).

### pathDirname(path)

### pathDirname.posix(path)

POSIX specific version.

### pathDirname.win32(path)

Windows specific version.


## License

MIT