Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs for pathToRegexp keys #340

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add docs for pathToRegexp keys #340

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion Readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ const fn = match("/foo/:bar");

## PathToRegexp

The `pathToRegexp` function returns a regular expression for matching strings against paths. It
The `pathToRegexp` function returns the `regexp` for matching strings against paths, and an array of `keys` for understanding the `RegExp#exec` matches.
ctcpip marked this conversation as resolved.
Show resolved Hide resolved

- **path** String or array of strings.
- **options** _(optional)_ (See [parse](#parse) for more options)
Expand All @@ -89,6 +89,8 @@ The `pathToRegexp` function returns a regular expression for matching strings ag

```js
const { regexp, keys } = pathToRegexp("/foo/:bar");

regexp.exec("/foo/123"); //=> ["/foo/123", "123"]
```

## Compile ("Reverse" Path-To-RegExp)
Expand Down
Loading