is-path-inside-commonjs

Check if a path is inside another path

CommonJS version of https://github.com/sindresorhus/is-path-inside

Install

npm install is-path-inside-commonjs

Usage

1import isPathInside from 'is-path-inside-commonjs';
2
3isPathInside('a/b/c', 'a/b');
4//=> true
5
6isPathInside('a/b/c', 'x/y');
7//=> false
8
9isPathInside('a/b/c', 'a/b/c');
10//=> false
11
12isPathInside('/Users/sindresorhus/dev/unicorn', '/Users/sindresorhus');
13//=> 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.