Kevin 29b9a0c50c clean && clean html base | 4 years ago | |
---|---|---|
.. | ||
LICENSE | 4 years ago | |
README.md | 4 years ago | |
index.js | 4 years ago | |
package.json | 4 years ago |
Remove leading directory components from a path, like tar(1)'s --strip-components
option
const stripDirs = require('strip-dirs');
stripDirs('foo/bar/baz', 1); //=> 'bar/baz'
stripDirs('foo/bar/baz', 2); //=> 'baz'
stripDirs('foo/bar/baz', 999); //=> 'baz'
npm install --save strip-dirs
const stripDirs = require('strip-dirs');
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.
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
instead of this module.
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.
stripDirs('foo/bar/baz', 9999); //=> 'baz'
stripDirs('foo/bar/baz', 9999, {disallowOverflow: true}); // throws an range error
Copyright (c) 2014 - 2016 Shinnosuke Watanabe
Licensed under the MIT License.