|
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475 |
- # strip-dirs
-
- [![NPM version](https://img.shields.io/npm/v/strip-dirs.svg)](https://www.npmjs.com/package/strip-dirs)
- [![Build Status](https://img.shields.io/travis/shinnn/node-strip-dirs.svg)](https://travis-ci.org/shinnn/node-strip-dirs)
- [![Build status](https://ci.appveyor.com/api/projects/status/pr5edbtg59f6xfgn?svg=true)](https://ci.appveyor.com/project/ShinnosukeWatanabe/node-strip-dirs)
- [![Coverage Status](https://img.shields.io/coveralls/shinnn/node-strip-dirs.svg)](https://coveralls.io/r/shinnn/node-strip-dirs)
- [![Dependency Status](https://david-dm.org/shinnn/node-strip-dirs.svg)](https://david-dm.org/shinnn/node-strip-dirs)
- [![devDependency Status](https://david-dm.org/shinnn/node-strip-dirs/dev-status.svg)](https://david-dm.org/shinnn/node-strip-dirs#info=devDependencies)
-
- Remove leading directory components from a path, like [tar(1)](http://linuxcommand.org/man_pages/tar1.html)'s `--strip-components` option
-
- ```javascript
- const stripDirs = require('strip-dirs');
-
- stripDirs('foo/bar/baz', 1); //=> 'bar/baz'
- stripDirs('foo/bar/baz', 2); //=> 'baz'
- stripDirs('foo/bar/baz', 999); //=> 'baz'
- ```
-
- ## Installation
-
- [Use npm](https://docs.npmjs.com/cli/install).
-
- ```
- npm install --save strip-dirs
- ```
-
- ## API
-
- ```javascript
- const stripDirs = require('strip-dirs');
- ```
-
- ### stripDirs(*path*, *count* [, *option*])
-
- *path*: `String` (A relative path)
- *count*: `Number` (0, 1, 2, ...)
- *option*: `Object`
- Return: `String`
-
- It removes directory components from the beginning of the *path* by *count*.
-
- ```javascript
- const stripDirs = require('strip-dirs');
-
- stripDirs('foo/bar', 1); //=> 'bar'
- stripDirs('foo/bar/baz', 2); //=> 'bar'
- stripDirs('foo/././/bar/./', 1); //=> 'bar'
- stripDirs('foo/bar', 0); //=> 'foo/bar'
-
- stripDirs('/foo/bar', 1) // throw an error because the path is an absolute path
- ```
-
- If you want to remove all directory components certainly, use [`path.basename`](https://nodejs.org/api/path.html#path_path_basename_path_ext) instead of this module.
-
- #### option.disallowOverflow
-
- Type: `Boolean`
- Default: `false`
-
- By default, it keeps the last path component when path components are fewer than the *count*.
-
- If this option is enabled, it throws an error in this situation.
-
- ```javascript
- stripDirs('foo/bar/baz', 9999); //=> 'baz'
-
- stripDirs('foo/bar/baz', 9999, {disallowOverflow: true}); // throws an range error
- ```
-
- ## License
-
- Copyright (c) 2014 - 2016 [Shinnosuke Watanabe](https://github.com/shinnn)
-
- Licensed under [the MIT License](./LICENSE).
|