Skip to content

Commit 55702b2

Browse files
committed
Update README examples using token delimiter
1 parent 43e87bf commit 55702b2

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

Readme.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ const { pathToRegexp, match, parse, compile } = require("path-to-regexp");
4242
const keys = [];
4343
const regexp = pathToRegexp("/foo/:bar", keys);
4444
// regexp = /^\/foo\/([^\/]+?)\/?$/i
45-
// keys = [{ name: 'bar', prefix: '/', delimiter: '/', optional: false, repeat: false, pattern: '[^\\/]+?' }]
45+
// keys = [{ name: 'bar', prefix: '/', suffix: '', pattern: '[^\\/#\\?]+?', modifier: '' }]
4646
```
4747

4848
**Please note:** The `RegExp` returned by `path-to-regexp` is intended for ordered data (e.g. pathnames, hostnames). It can not handle arbitrarily ordered data (e.g. query strings, URL fragments, JSON, etc). When using paths that contain query strings, you need to escape the question mark (`?`) to ensure it does not flag the parameter as [optional](#optional).
@@ -127,7 +127,7 @@ Parameters can be suffixed with a question mark (`?`) to make the parameter opti
127127

128128
```js
129129
const regexp = pathToRegexp("/:foo/:bar?");
130-
// keys = [{ name: 'foo', ... }, { name: 'bar', delimiter: '/', optional: true, repeat: false }]
130+
// keys = [{ name: 'foo', ... }, { name: 'bar', prefix: '/', modifier: '?' }]
131131

132132
regexp.exec("/test");
133133
//=> [ '/test', 'test', undefined, index: 0, input: '/test', groups: undefined ]
@@ -157,7 +157,7 @@ Parameters can be suffixed with an asterisk (`*`) to denote a zero or more param
157157

158158
```js
159159
const regexp = pathToRegexp("/:foo*");
160-
// keys = [{ name: 'foo', delimiter: '/', optional: true, repeat: true }]
160+
// keys = [{ name: 'foo', prefix: '/', modifier: '*' }]
161161

162162
regexp.exec("/");
163163
//=> [ '/', undefined, index: 0, input: '/', groups: undefined ]
@@ -172,7 +172,7 @@ Parameters can be suffixed with a plus sign (`+`) to denote a one or more parame
172172

173173
```js
174174
const regexp = pathToRegexp("/:foo+");
175-
// keys = [{ name: 'foo', delimiter: '/', optional: false, repeat: true }]
175+
// keys = [{ name: 'foo', prefix: '/', modifier: '+' }]
176176

177177
regexp.exec("/");
178178
//=> null
@@ -246,10 +246,10 @@ console.log(tokens[0]);
246246
//=> "/route"
247247

248248
console.log(tokens[1]);
249-
//=> { name: 'foo', prefix: '/', delimiter: '/', optional: false, repeat: false, pattern: '[^\\/]+?' }
249+
//=> { name: 'foo', prefix: '/', suffix: '', pattern: '[^\\/#\\?]+?', modifier: '' }
250250

251251
console.log(tokens[2]);
252-
//=> { name: 0, prefix: '/', delimiter: '/', optional: false, repeat: false, pattern: '.*' }
252+
//=> { name: 0, prefix: '/', suffix: '', pattern: '.*', modifier: '' }
253253
```
254254

255255
**Note:** This method only works with strings.

0 commit comments

Comments
 (0)