Needlessly Promiscuous, Modularize!

    is-path-inside
    TypeScript icon, indicating that this package has built-in type declarations

    4.0.0 • Public • Published

    is-path-inside

    Check if a path is inside another path

    Install

    $ npm install is-path-inside
    

    Usage

    import isPathInside from '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.


    Get professional support for this package with a Tidelift subscription
    Tidelift helps make open source sustainable for maintainers while giving companies
    assurances about security, maintenance, and licensing for their dependencies.

    Install

    npm i is-path-inside

    DownloadsWeekly Downloads

    22,327,632

    Version

    4.0.0

    License

    MIT

    Unpacked Size

    4.2 kB

    Total Files

    5

    Last publish

    Collaborators

    • sindresorhus