README.md
2.27 KB
contains-path
Return true if a file path contains the given path.
Install
Install with npm
$ npm i contains-path --save
Usage
var contains = require('contains-path');
true
All of the following return true
:
containsPath('./a/b/c', 'a');
containsPath('./a/b/c', 'a/b');
containsPath('./b/a/b/c', 'a/b');
containsPath('/a/b/c', '/a/b');
containsPath('/a/b/c', 'a/b');
containsPath('a', 'a');
containsPath('a/b/c', 'a');
//=> true
false
All of the following return false
:
containsPath('abc', 'a');
containsPath('abc', 'a.md');
containsPath('./b/a/b/c', './a/b');
containsPath('./b/a/b/c', './a');
containsPath('./b/a/b/c', '/a/b');
containsPath('/b/a/b/c', '/a/b');
//=> false
Related projects
-
ends-with: Returns
true
if the givenstring
orarray
ends withsuffix
using strict equality for… more - is-absolute: Return true if a file path is absolute.
-
is-relative: Returns
true
if the path appears to be relative. -
path-ends-with: Return
true
if a file path ends with the given string/suffix. - path-segments: Get n specific segments of a file path, e.g. first 2, last 3, etc.
- parse-filepath: Parse a filepath into an object, yielding predictable results for basename and extname.
Running tests
Install dev dependencies:
$ npm i -d && npm test
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue
Author
Jon Schlinkert
License
Copyright © 2015 Jon Schlinkert Released under the MIT license.
This file was generated by verb-cli on July 07, 2015.