# path-starts-with
> Returns true if a filepath starts with the given string. Works with windows and posix/unix paths.
Latest version **2.0.1** (published 2023-07-29) · MIT license · 35.9K weekly downloads
## Install
```sh
npm install path-starts-with
pnpm add path-starts-with
yarn add path-starts-with
bun add path-starts-with
```
## Health
**Score 25/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: no types; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 2.0.1 |
| Published | 2023-07-29 |
| First published | 2017-04-17 |
| Weekly downloads | 35.9K |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8 |
| Dependencies | 0 |
| Unpacked size | 9.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 6 |
| Author | Jon Schlinkert |
| Maintainers | jonschlinkert |
| Keywords | directory, file path, file, filepath, folder, fs, inside, path, posix, relative, slash, slashes, starts, startsWith, util, utility, utils, windows |
## Links
- npm: https://www.npmjs.com/package/path-starts-with
- Repository: https://github.com/jonschlinkert/path-starts-with
- Issues: https://github.com/jonschlinkert/path-starts-with/issues
- npm.io page: https://npm.io/package/path-starts-with
## Alternatives
- [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads
- [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads
- [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads
- [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads
- [restbox](https://npm.io/package/restbox.md) — 328 weekly downloads
## Recent versions
- 2.0.1 (latest) — 2023-07-29
- 2.0.0 — 2019-04-29
- 1.0.0 — 2017-04-17
## 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._
---
_Source: https://npm.io/package/path-starts-with · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._