Socket
Socket
Sign inDemoInstall

is-path-inside

Package Overview
Dependencies
0
Maintainers
1
Versions
10
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    is-path-inside

Check if a path is inside another path


Version published
Maintainers
1
Install size
5.16 kB
Created

Package description

What is is-path-inside?

The is-path-inside npm package is used to determine if one path is inside another path. This can be useful for ensuring that a file or directory is contained within a specific directory structure, which is a common requirement in file system operations to maintain security and proper organization.

What are is-path-inside's main functionalities?

Check if a path is inside another path

This feature allows you to check if one path is inside another. It returns true if the first path is inside the second path, otherwise false.

const isPathInside = require('is-path-inside');

console.log(isPathInside('/some/dir', '/some/dir/file.txt')); // true
console.log(isPathInside('/some/dir', '/some/other/dir')); // false

Other packages similar to is-path-inside

Readme

Source

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.

Keywords

FAQs

Last updated on 03 May 2021

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc