Skip to content

Commit 675bc5b

Browse files
committed
Add note to README on path matching
Closes #91.
1 parent 44c69d5 commit 675bc5b

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

Readme.md

+2
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,8 @@ var re = pathToRegexp('/foo/:bar', keys)
4040
// keys = [{ name: 'bar', prefix: '/', delimiter: '/', optional: false, repeat: false, pattern: '[^\\/]+?' }]
4141
```
4242

43+
**Please note:** The `RegExp` returned by `path-to-regexp` is intended for use with pathnames or hostnames. It can not handle the query strings or fragments of a URL.
44+
4345
### Parameters
4446

4547
The path string can be used to define parameters and populate the keys.

0 commit comments

Comments
 (0)