aboutsummaryrefslogtreecommitdiff
path: root/node_modules/is-path-inside/index.d.ts
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/index.d.ts
downloadequestriadb-383285ecd5292bf9a825e05904955b937de84cc9.tar.gz
equestriadb-383285ecd5292bf9a825e05904955b937de84cc9.tar.bz2
equestriadb-383285ecd5292bf9a825e05904955b937de84cc9.zip
Initial commit
Diffstat (limited to 'node_modules/is-path-inside/index.d.ts')
-rw-r--r--node_modules/is-path-inside/index.d.ts27
1 files changed, 27 insertions, 0 deletions
diff --git a/node_modules/is-path-inside/index.d.ts b/node_modules/is-path-inside/index.d.ts
new file mode 100644
index 0000000..5cc3d80
--- /dev/null
+++ b/node_modules/is-path-inside/index.d.ts
@@ -0,0 +1,27 @@
+/**
+Check if a path is inside another path.
+
+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.
+
+@example
+```
+import 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
+```
+*/
+declare function isPathInside(childPath: string, parentPath: string): boolean;
+
+export = isPathInside;