Merge branch 'master' into 260-asterisk-parameter

Author: blakeembrey

.github/workflows/ci.yml

@@ -0,0 +1,30 @@
+name: CI
+on:
+  - push
+  - pull_request
+jobs:
+  test:
+    name: Node.js ${{ matrix.node-version }}
+    runs-on: macos-latest
+    strategy:
+      matrix:
+        node-version:
+          - "12"
+          - "*"
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+      - uses: actions/cache@v2
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
+      - run: npm install -g npm@8
+      - run: npm ci
+      - run: npm test
+      - uses: codecov/codecov-action@v1
+        with:
+          name: Node.js ${{ matrix.node-version }}

.travis.yml

@@ -3,11 +3,10 @@
 > Turn a path string such as `/user/:name` into a regular expression.
 
 [![NPM version][npm-image]][npm-url]
-[![Build status][travis-image]][travis-url]
-[![Test coverage][coveralls-image]][coveralls-url]
-[![Dependency Status][david-image]][david-url]
+[![NPM downloads][downloads-image]][downloads-url]
+[![Build status][build-image]][build-url]
+[![Build coverage][coverage-image]][coverage-url]
 [![License][license-image]][license-url]
-[![Downloads][downloads-image]][downloads-url]
 
 ## Installation
 
@@ -26,9 +25,13 @@ const { pathToRegexp, match, parse, compile } = require("path-to-regexp");
 // compile(path)
 ```
 
+### Path to regexp
+
+The `pathToRegexp` function will return a regular expression object based on the provided `path` argument. It accepts the following arguments:
+
 - **path** A string, array of strings, or a regular expression.
-- **keys** An array to populate with keys found in the path.
-- **options**
+- **keys** _(optional)_ An array to populate with keys found in the path.
+- **options** _(optional)_
   - **sensitive** When `true` the regexp will be case sensitive. (default: `false`)
   - **strict** When `true` the regexp won't allow an optional trailing delimiter to match. (default: `false`)
   - **end** When `true` the regexp will match to the end of the string. (default: `true`)
@@ -194,6 +197,23 @@ fn("/invalid"); //=> false
 fn("/user/caf%C3%A9"); //=> { path: '/user/caf%C3%A9', index: 0, params: { id: 'café' } }
 ```
 
+The `match` function can be used to custom match named parameters. For example, this can be used to whitelist a small number of valid paths:
+
+```js
+const urlMatch = match("/users/:id/:tab(home|photos|bio)", {
+  decode: decodeURIComponent,
+});
+
+urlMatch("/users/1234/photos");
+//=> { path: '/users/1234/photos', index: 0, params: { id: '1234', tab: 'photos' } }
+
+urlMatch("/users/1234/bio");
+//=> { path: '/users/1234/bio', index: 0, params: { id: '1234', tab: 'bio' } }
+
+urlMatch("/users/1234/otherstuff");
+//=> false
+```
+
 #### Process Pathname
 
 You should make sure variations of the same path match the expected `path`. Here's one possible solution using `encode`:
@@ -321,15 +341,13 @@ You can see a live demo of this library in use at [express-route-tester](http://
 
 MIT
 
-[npm-image]: https://img.shields.io/npm/v/path-to-regexp.svg?style=flat
+[npm-image]: https://img.shields.io/npm/v/path-to-regexp
 [npm-url]: https://npmjs.org/package/path-to-regexp
-[travis-image]: https://img.shields.io/travis/pillarjs/path-to-regexp.svg?style=flat
-[travis-url]: https://travis-ci.org/pillarjs/path-to-regexp
-[coveralls-image]: https://img.shields.io/coveralls/pillarjs/path-to-regexp.svg?style=flat
-[coveralls-url]: https://coveralls.io/r/pillarjs/path-to-regexp?branch=master
-[david-image]: http://img.shields.io/david/pillarjs/path-to-regexp.svg?style=flat
-[david-url]: https://david-dm.org/pillarjs/path-to-regexp
+[downloads-image]: https://img.shields.io/npm/dm/path-to-regexp
+[downloads-url]: https://npmjs.org/package/path-to-regexp
+[build-image]: https://img.shields.io/github/workflow/status/pillarjs/path-to-regexp/CI/master
+[build-url]: https://github.com/pillarjs/path-to-regexp/actions/workflows/ci.yml?query=branch%3Amaster
+[coverage-image]: https://img.shields.io/codecov/c/gh/pillarjs/path-to-regexp
+[coverage-url]: https://codecov.io/gh/pillarjs/path-to-regexp
 [license-image]: http://img.shields.io/npm/l/path-to-regexp.svg?style=flat
 [license-url]: LICENSE.md
-[downloads-image]: http://img.shields.io/npm/dm/path-to-regexp.svg?style=flat
-[downloads-url]: https://npmjs.org/package/path-to-regexp