aboutsummaryrefslogtreecommitdiff
path: root/node_modules/is-path-inside/readme.md
diff options
context:
space:
mode:
authorMinteck <contact@minteck.org>2022-06-04 08:51:01 +0200
committerMinteck <contact@minteck.org>2022-06-04 08:51:01 +0200
commit383285ecd5292bf9a825e05904955b937de84cc9 (patch)
tree0a53b6f02c1604b078044567c03dc1b6c944c8c2 /node_modules/is-path-inside/readme.md
downloadequestriadb-383285ecd5292bf9a825e05904955b937de84cc9.tar.gz
equestriadb-383285ecd5292bf9a825e05904955b937de84cc9.tar.bz2
equestriadb-383285ecd5292bf9a825e05904955b937de84cc9.zip
Initial commit
Diffstat (limited to 'node_modules/is-path-inside/readme.md')
-rw-r--r--node_modules/is-path-inside/readme.md63
1 files changed, 63 insertions, 0 deletions
diff --git a/node_modules/is-path-inside/readme.md b/node_modules/is-path-inside/readme.md
new file mode 100644
index 0000000..e8c4f92
--- /dev/null
+++ b/node_modules/is-path-inside/readme.md
@@ -0,0 +1,63 @@
+# is-path-inside
+
+> Check if a path is inside another path
+
+
+## Install
+
+```
+$ npm install is-path-inside
+```
+
+
+## Usage
+
+```js
+const isPathInside = require('is-path-inside');
+
+isPathInside('a/b/c', 'a/b');
+//=> true
+
+isPathInside('a/b/c', 'x/y');
+//=> false
+
+isPathInside('a/b/c', 'a/b/c');
+//=> false
+
+isPathInside('/Users/sindresorhus/dev/unicorn', '/Users/sindresorhus');
+//=> true
+```
+
+
+## API
+
+### isPathInside(childPath, parentPath)
+
+Note that relative paths are resolved against `process.cwd()` to make them absolute.
+
+**Important:** This package is meant for use with path manipulation. It does not check if the paths exist nor does it resolve symlinks. You should not use this as a security mechanism to guard against access to certain places on the file system.
+
+#### childPath
+
+Type: `string`
+
+The path that should be inside `parentPath`.
+
+#### parentPath
+
+Type: `string`
+
+The path that should contain `childPath`.
+
+
+---
+
+<div align="center">
+ <b>
+ <a href="https://tidelift.com/subscription/pkg/npm-is-path-inside?utm_source=npm-is-path-inside&utm_medium=referral&utm_campaign=readme">Get professional support for this package with a Tidelift subscription</a>
+ </b>
+ <br>
+ <sub>
+ Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies.
+ </sub>
+</div>