# @eggjs/path-matching 中文文档

规范地址：https://npmcn.com/package/%40eggjs/path-matching/

版本：3\.1\.0
npm 元数据更新时间：2026-10-07T08:18:40.945Z
中文译文更新时间：2026-11-13T12:53:15.548Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40eggjs/path-matching
原文对照：https://npmcn.com/package/%40eggjs/path-matching/?lang=original
项目主页：https://github.com/eggjs/egg/tree/next/packages/path-matching
源码仓库：https://github.com/eggjs/egg

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：6.4 kB，5 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.18\.0
- 运行依赖：1 个
- 首次发布：2025-10-08T12:56:18.827Z
- 最新版本发布：2026-10-07T08:18:40.594Z
- 近 30 天下载量：3794（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：44（近 12 个月 36 个）

## 中文简介

匹配或忽略 url 路径

## 安装

```sh
npm install @eggjs/path-matching
```

也可以使用：`pnpm add @eggjs/path-matching`、`yarn add @eggjs/path-matching`、`bun add @eggjs/path-matching`

## README

# @eggjs/ 路径匹配

[![NPM version](https://img.shields.io/npm/v/@eggjs/path-matching.svg?style=flat-square)](https://npmjs.org/package/@eggjs/path-matching) [![Known Vulnerabilities](https://snyk.io/test/npm/@eggjs/path-matching/badge.svg?style=flat-square)](https://snyk.io/test/npm/@eggjs/path-matching/badge.svg?style=flat-square) [![npm download](https://img.shields.io/npm/dm/@eggjs/path-matching.svg?style=flat-square)](https://npmjs.org/package/@eggjs/path-matching)

## 安装

```bash
npm install @eggjs/path-matching
```

## 使用量

```ts
import { pathMatching } from '@eggjs/path-matching';

const options = {
  ignore: '/api', // string will use parsed by path-to-regexp
  // support regexp
  ignore: /^\/api/,
  // support function
  ignore: (ctx) => ctx.path.startsWith('/api'),
  // support Array
  ignore: [(ctx) => ctx.path.startsWith('/api'), /^\/foo$/, '/bar'],
  // support match or ignore
  match: '/api',
  // custom path-to-regexp module, default is `path-to-regexp@6`
  // pathToRegexpModule: customPathToRegexp,
};

const match = pathMatching(options);
assert.equal(match({ path: '/api' }), true);
assert.equal(match({ path: '/api/hello' }), true);
assert.equal(match({ path: '/api' }), true);
```

### 选项

-   `match` {String }\\ RegExp }\\ 函数 { sarray} - 如果请求路径被击中 `options.match`,将返回 `true`,否则将返回 `false`。 。 。 .
-   `ignore` {String }\\ RegExp }\\ 函数 { sarray} - 如果请求路径被击中 `options.ignore`,将返回 `false`,否则将返回 `true`。 。 。 .
-   `pathToRegexpModule` {Object } - 自定义路径到 regexp 模块 。 默认是 `path-to-regexp@6`。支持两者 `path-to-regexp@6` 财务报告和审定财务报表 `path-to-regexp@8+` 格式.

`ignore` 财务报告和审定财务报表 `match` 无法同时呈现. 如果没有 `ignore` 也没有 `match` 显示,新函数将永远返回 `true`。 。 。 .

### 许可证

[麻省理工学院](https://npmcn.com/package/%40eggjs/path-matching/LICENSE)

## 贡献者

[![Contributors](https://contrib.rocks/image?repo=eggjs/egg)](https://github.com/eggjs/egg/graphs/contributors)

制造的 [贡献者-img](https://contrib.rocks/)。 。 。 .

## 常见问题

### @eggjs/path-matching 是什么？

匹配或忽略 url 路径

### 如何安装 @eggjs/path-matching？

在项目目录运行 npm install @eggjs/path-matching，或使用 pnpm add / yarn add / bun add。

### @eggjs/path-matching 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @eggjs/path-matching 支持 ESM 还是 CommonJS？

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

### @eggjs/path-matching 需要什么版本的 Node\.js？

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

### @eggjs/path-matching 可以商用吗？

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

### @eggjs/path-matching 的下载量有多少？

根据 npm 官方下载统计，@eggjs/path-matching 在 2026/10/13 – 2026/11/11 这 30 天内被下载 3,794 次，日均约 126 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @eggjs/path-matching 还在维护吗？

最新版本 3\.1\.0 发布于 2026/10/07（1 个月前）；至今共发布 44 个版本，其中过去 12 个月发布了 36 个；首次发布于 2025/10/08。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。