https://github.com/eggjs/egg-path-matching

url path match/ignore support string, regexp and function
https://github.com/eggjs/egg-path-matching

Last synced: 5 months ago
JSON representation

url path match/ignore support string, regexp and function

• Host: GitHub
• URL: https://github.com/eggjs/egg-path-matching
• Owner: eggjs
• License: mit
• Created: 2016-11-14T15:12:01.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2025-10-08T06:19:32.000Z (9 months ago)
• Last Synced: 2025-10-08T08:20:21.650Z (9 months ago)
• Language: TypeScript
• Homepage:
• Size: 99.6 KB
• Stars: 28
• Watchers: 7
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# egg-path-matching

[![NPM version][npm-image]][npm-url]

[![CI](https://github.com/eggjs/egg-path-matching/actions/workflows/nodejs.yml/badge.svg)](https://github.com/eggjs/egg-path-matching/actions/workflows/nodejs.yml)

[![Test coverage](https://img.shields.io/codecov/c/github/eggjs/egg-path-matching.svg?style=flat-square)](https://codecov.io/gh/eggjs/egg-path-matching)

[![Known Vulnerabilities][snyk-image]][snyk-url]

[![npm download][download-image]][download-url]

[npm-image]: https://img.shields.io/npm/v/egg-path-matching.svg?style=flat-square

[npm-url]: https://npmjs.org/package/egg-path-matching

[snyk-image]: https://snyk.io/test/npm/egg-path-matching/badge.svg?style=flat-square

[snyk-url]: https://snyk.io/test/npm/egg-path-matching

[download-image]: https://img.shields.io/npm/dm/egg-path-matching.svg?style=flat-square

[download-url]: https://npmjs.org/package/egg-path-matching

## Installation

```bash

npm install egg-path-matching

```

## Usage

```ts

import { pathMatching } from 'egg-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);

```

### options

- `match` {String | RegExp | Function | Array} - if request path hit `options.match`, will return `true`, otherwise will return `false`.

- `ignore` {String | RegExp | Function | Array} - if request path hit `options.ignore`, will return `false`, otherwise will return `true`.

- `pathToRegexpModule` {Object | Function} - custom path-to-regexp module. Default is `path-to-regexp@6`. Supports both `path-to-regexp@6` and `path-to-regexp@8+` formats.

`ignore` and `match` can not both be presented.

and if neither `ignore` nor `match` presented, the new function will always return `true`.

### License

[MIT](LICENSE)

## Contributors

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

Made with [contributors-img](https://contrib.rocks).