40 lines
1021 B
Plaintext
40 lines
1021 B
Plaintext
# is-subdir
|
|
|
|
> Return whether a directory is a subdirectory of another directory
|
|
|
|
<!--@shields('npm')-->
|
|
[](https://www.npmjs.com/package/is-subdir)
|
|
<!--/@-->
|
|
|
|
Cross-platform. Works correctly on Windows, where directory paths can start with disk drive letters in different casings. Like `c:\foo` and `C:\foo\bar`.
|
|
|
|
Returns `true` when the directories match. The `isSubdir.strict()` variant only returns true if the second parameter is a strict subdir of the first and not the same.
|
|
|
|
## Installation
|
|
|
|
```sh
|
|
<npm|yarn|pnpm> add is-subdir
|
|
```
|
|
|
|
## Usage
|
|
|
|
```js
|
|
'use strict'
|
|
const path = require('path')
|
|
const isSubdir = require('is-subdir')
|
|
|
|
console.log(isSubdir(process.cwd(), path.resolve('node_modules')))
|
|
//> true
|
|
console.log(isSubdir.strict('node_modules/tape', '../tape'))
|
|
//> false
|
|
```
|
|
|
|
## API
|
|
|
|
### `isSubdir(parentDir, subdir): boolean`
|
|
### `isSubdir.strict(parentDir, subdir): boolean`
|
|
|
|
## License
|
|
|
|
[MIT](./LICENSE) © [Zoltan Kochan](https://www.kochan.io)
|