https://github.com/jrop/path-to-re

A lightweight alternative to path-to-regexp
https://github.com/jrop/path-to-re

path regexp regexp-match url

Last synced: about 1 month ago
JSON representation

A lightweight alternative to path-to-regexp

• Host: GitHub
• URL: https://github.com/jrop/path-to-re
• Owner: jrop
• Created: 2017-07-26T18:22:28.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-09-01T17:34:47.000Z (over 7 years ago)
• Last Synced: 2024-11-12T05:38:06.677Z (about 1 month ago)
• Topics: path, regexp, regexp-match, url
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/path-to-re
• Size: 3.91 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# path-to-re

> A lightweight alternative to `path-to-regexp`

# Installation

```sh

$ npm install --save path-to-re

```

# Usage

```js

import createMatcher, {toRe} from 'path-to-re'

const regExp = toRe('/some/path/:param/:optional?')

regExp.keys // => ['param', 'optional']

const matcher = createMatcher('/some/path/:param/:optional?')

matcher('/nope') // => null

matcher('/some/path/value1') // => {param: 'value1'}

matcher('/some/path/value1/value2') // => {param: 'value1', optional: 'value2'}

```

# License (ISC)

ISC License (ISC)

Copyright 2017 

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.