Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jonschlinkert/path-starts-with
Returns true if a filepath starts with the given string. Works with windows and posix/unix paths.
https://github.com/jonschlinkert/path-starts-with
endswith file filepath fs javascript jonschlinkert leading-slash path posix slash startswith string windows
Last synced: about 2 months ago
JSON representation
Returns true if a filepath starts with the given string. Works with windows and posix/unix paths.
- Host: GitHub
- URL: https://github.com/jonschlinkert/path-starts-with
- Owner: jonschlinkert
- License: mit
- Created: 2017-04-17T06:42:37.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-07-29T23:27:06.000Z (over 1 year ago)
- Last Synced: 2024-05-08T18:14:06.793Z (8 months ago)
- Topics: endswith, file, filepath, fs, javascript, jonschlinkert, leading-slash, path, posix, slash, startswith, string, windows
- Language: JavaScript
- Homepage: https://github.com/jonschlinkert/path-starts-with
- Size: 18.6 KB
- Stars: 6
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/contributing.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# path-starts-with [](https://www.npmjs.com/package/path-starts-with) [](https://npmjs.org/package/path-starts-with) [](https://npmjs.org/package/path-starts-with)
> Returns true if a filepath starts with the given string. Works with windows and posix/unix paths.
Please consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install --save path-starts-with
```
## Usage
```js
var startsWith = require('path-starts-with');
console.log(startsWith('foo/bar', 'foo')); //=> true
console.log(startsWith('foo/bar', 'bar')); //=> false
```
## Negation
Prefix the substring with `!` to return true when the path _does not_ start with the substring.
```js
console.log(startsWith('foo/bar', '!foo')); //=> false
console.log(startsWith('foo/bar', '!bar')); //=> true
```
## options
### options.nocase
**Type**: `boolean`
**Default**: `false`
Disable case sensitivity.
```js
startsWith('foo/bar', 'FOO');
//=> false
startsWith('foo/bar', 'FOO', {nocase: true});
//=> true
```
### options.partialMatch
**Type**: `boolean`
**Default**: `false`
Allow partial matches:
```js
startsWith('foobar', 'foo'); //=> false
startsWith('foo.bar', 'foo'); //=> false
startsWith('foobar', 'foo', {partialMatch: true}); //=> true
startsWith('foo.bar', 'foo', {partialMatch: true}); //=> true
```
## Comparison behavior
### Windows paths
Backslashes are converted to forward slashes before the comparison is done. Thus, both of the following would be `true`:
```js
console.log(startsWith('foo\\bar', 'foo/bar')); //=> true
console.log(startsWith('foo/bar', 'foo\\bar')); //=> true
```
### Leading dot-slash
Leading `./` is stripped from both the filepath and substring. Thus, both of the following would be `true`:
```js
console.log(startsWith('./foo/bar', 'foo')); //=> true
console.log(startsWith('foo/bar', './foo')); //=> true
```
### Leading slashes
When the substring is prefixed with leading slashes, _the number of leading slashes_ must match exactly.
```js
console.log(startsWith('/foo', '/foo')); //=> true
console.log(startsWith('/foo/bar', '/foo')); //=> true
console.log(startsWith('/foo/bar', '//foo')); //=> false
console.log(startsWith('//foo/bar', '/foo')); //=> false
```
## About
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
Please read the [contributing guide](.github/contributing.md) for advice on opening issues, pull requests, and coding standards.
Running Tests
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
```sh
$ npm install && npm test
```
Building docs
_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
To generate the readme, run the following command:
```sh
$ npm install -g verbose/verb#dev verb-generate-readme && verb
```
### Related projects
You might also be interested in these projects:
* [contains-path](https://www.npmjs.com/package/contains-path): Return true if a file path contains the given path. | [homepage](https://github.com/jonschlinkert/contains-path "Return true if a file path contains the given path.")
* [normalize-path](https://www.npmjs.com/package/normalize-path): Normalize slashes in a file path to be posix/unix-like forward slashes. Also condenses repeat slashes… [more](https://github.com/jonschlinkert/normalize-path) | [homepage](https://github.com/jonschlinkert/normalize-path "Normalize slashes in a file path to be posix/unix-like forward slashes. Also condenses repeat slashes to a single slash and removes and trailing slashes, unless disabled.")
* [path-ends-with](https://www.npmjs.com/package/path-ends-with): Return `true` if a file path ends with the given string/suffix. | [homepage](https://github.com/jonschlinkert/path-ends-with "Return `true` if a file path ends with the given string/suffix.")
### Author
**Jon Schlinkert**
* [GitHub Profile](https://github.com/jonschlinkert)
* [Twitter Profile](https://twitter.com/jonschlinkert)
* [LinkedIn Profile](https://linkedin.com/in/jonschlinkert)
### License
Copyright © 2023, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT License](LICENSE).
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.8.0, on July 29, 2023._