node-match-path

Matches a URL against the given path.

Getting started

Install

1npm install node-match-path

Usage

1const { match } = require('node-match-path')
2
3match('/user/:userId', '/user/5')
4/*
5{
6  matches: true,
7  params: {
8    userId: '5'
9  }
10}
11*/

API

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

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

String path

1match('/admin', '/admin')
2
3/*
4{
5  matches: true,
6  params: null
7}
8*/

Path parameters

1match('/admin/:messageId', '/admin/abc-123')
2
3/*
4{
5  matches: true,
6  params: {
7    messageId: 'abc-123'
8  }
9}
10*/

Wildcard

1match('/user/*/inbox', '/user/abc-123/inbox')
2
3/*
4{
5  matches: true,
6  params: null
7}
8*/

Regular expression

1match(/\/messages\/.+?\/participants/, '/messages/5/participants')
2
3/*
4{
5  matches: true,
6  params: null
7}
8*/

Honorable mentions

• path-to-regexp