node-match-path

Dependency-free request URI matcher

Last updated 6 years ago by kettanaito .

MIT · Original npm · Tarball · package.json

$ cnpm install node-match-path

SYNC missed versions from official npm registry.

`node-match-path`

Matches a URL against the given path.

Getting started

Install

npm install node-match-path

Usage

const { match } = require('node-match-path')

match('/user/:userId', '/user/5')
/*
{
  matches: true,
  params: {
    userId: '5'
  }
}
*/

API

`match(path: RegExp | string, url: string): Match`

Returns a match data, if any, between a url and a path.

String path

match('/admin', '/admin')

/*
{
  matches: true,
  params: null
}
*/

Path parameters

match('/admin/:messageId', '/admin/abc-123')

/*
{
  matches: true,
  params: {
    messageId: 'abc-123'
  }
}
*/

Wildcard

match('/user/*/inbox', '/user/abc-123/inbox')

/*
{
  matches: true,
  params: null
}
*/

Regular expression

match(/\/messages\/.+?\/participants/, '/messages/5/participants')

/*
{
  matches: true,
  params: null
}
*/

Honorable mentions

path-to-regexp

Current Tags

0.6.3 ... latest (5 years ago)

19 Versions

Maintainers (1)

Downloads

Today 0

This Week 0

This Month 19

Last Day 0

Last Week 25

Last Month 7

Dependencies (0)

None

Dev Dependencies (12)

@babel/core 7.9.0
@babel/preset-env ^7.5.5
@types/jest ^24.0.15
jest ^24.8.0
rimraf ^2.6.3
rollup ^1.17.0
rollup-plugin-babel ^4.3.3
rollup-plugin-node-resolve ^5.2.0
rollup-plugin-sourcemaps ^0.4.2
rollup-plugin-typescript2 ^0.22.0
ts-jest ^24.0.2
typescript ^3.5.3

Dependents (1)

msw

Copyright 2013 - present © cnpmjs.org | Home |