Sha256: fef8a0944e2165dde89df402f87530e558fe25f5fe15e439679d710aa1ee19dc
Contents?: true
Size: 1.54 KB
Versions: 8
Compression:
Stored size: 1.54 KB
Contents
# parents
Return all the parent directories of a directory, inclusive of that directory.
[](http://travis-ci.org/substack/node-parents)
# example
## dirname
``` js
var parents = require('parents');
var dirs = parents(__dirname);
console.dir(dirs);
```
***
```
[ '/home/substack/projects/node-parents/example',
'/home/substack/projects/node-parents',
'/home/substack/projects',
'/home/substack',
'/home',
'/' ]
```
## win32
``` js
var parents = require('parents');
var dir = 'C:\\Program Files\\Maxis\\Sim City 2000\\cities';
var dirs = parents(dir, { platform : 'win32' });
console.dir(dirs);
```
***
```
[ 'C:\\Program Files\\Maxis\\Sim City 2000\\cities',
'C:\\Program Files\\Maxis\\Sim City 2000',
'C:\\Program Files\\Maxis',
'C:\\Program Files',
'C:' ]
```
# methods
``` js
var parents = require('parents')
```
## parents(dir, opts)
Return an array of the parent directories of `dir`, including and starting with
`dir`. If a `dir` isn't specified, `process.cwd()` will be used.
Optionally specify an `opts.platform` to control whether the separator and paths
works the unixy way with `'/'` or the windowsy way where sometimes things use
`'/'` and sometimes they use `'\\'` and also there are leading drive letters and
other exotic features. If `opts.platform` isn't specified, `process.platform`
will be used. Anything that matches `/^win/` will use the windowsy behavior.
# install
With [npm](http://npmjs.org) do:
```
npm install parents
```
# licence
MIT
Version data entries
8 entries across 8 versions & 3 rubygems