is-path-inside

中文文档
4.0.0发布于 2021/05/03MITES Module零依赖近 30 天下载 3亿

Check if a path is inside another path

原始使用文档
文档目录4 节
  1. Install
  2. Usage
  3. API
  4. isPathInside(childPath, parentPath)

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.

版本与发布记录

is-path-inside 共发布 10 个版本,首次发布于 2014/06/21;过去 12 个月发布了 0 个版本。

版本发布日期距今
4.0.0latest2021/05/035 年前
3.0.32021/03/085 年前
3.0.22019/09/307 年前
3.0.12019/07/067 年前
3.0.02019/07/057 年前
2.1.02019/04/167 年前

关于 is-path-inside 的常见问题

is-path-inside 是什么?

Check if a path is inside another path

如何安装 is-path-inside?

在项目目录运行 npm install is-path-inside,或使用 pnpm add / yarn add / bun add。

is-path-inside 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/is-path-inside 是否存在。

is-path-inside 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

is-path-inside 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=12。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

is-path-inside 可以商用吗?

is-path-inside 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

is-path-inside 的下载量有多少?

根据 npm 官方下载统计,is-path-inside 在 2026/10/07 – 2026/11/05 这 30 天内被下载 299,899,420 次,日均约 9,996,647 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

is-path-inside 还在维护吗?

最新版本 4.0.0 发布于 2021/05/03(5 年前);至今共发布 10 个版本,其中过去 12 个月发布了 0 个;首次发布于 2014/06/21。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。