Skip to content

Commit 1a3107a

Browse files
committed
add documentation on asterisk functionality
1 parent 271ce5d commit 1a3107a

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

Readme.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,18 @@ re.exec('/test/route')
129129
//=> ['/test/route', 'test', 'route']
130130
```
131131

132+
#### Asterisk
133+
134+
An asterisk can be used for matching everything. It is equivalent to an unnamed matching group of `(.*)`.
135+
136+
```js
137+
var re = pathToRegexp('/foo/*', keys)
138+
// keys = [{ name: '0', ... }]
139+
140+
re.exec('/foo/bar/baz')
141+
//=> ['/foo/bar/baz', 'bar/baz']
142+
```
143+
132144
### Parse
133145

134146
The parse function is exposed via `pathToRegexp.parse`. This will yield an array of strings and keys.

0 commit comments

Comments
 (0)