Skip to content

Commit df4ef43

Browse files
committed
Clean up option language in docs
1 parent 06032a4 commit df4ef43

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

Readme.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,11 @@ var pathToRegexp = require('path-to-regexp')
2626
```
2727

2828
- **path** A string, array of strings, or a regular expression.
29-
- **keys** An array to be populated with the keys found in the path.
29+
- **keys** An array to be populated with keys found in the path.
3030
- **options**
31-
- **sensitive** When `true` the route will be case sensitive. (default: `false`)
32-
- **strict** When `false` the trailing slash is optional. (default: `false`)
33-
- **end** When `false` the path will match at the beginning. (default: `true`)
31+
- **sensitive** When `true` the regexp will be case sensitive. (default: `false`)
32+
- **strict** When `true` the regexp allows an optional trailing delimiter to match. (default: `false`)
33+
- **end** When `false` the regexp will match the beginning instead of the entire string. (default: `true`)
3434
- Advanced options (use for non-pathname strings, e.g. host names):
3535
- **delimiter** The default delimiter for segments. (default: `'/'`)
3636
- **endsWith** Optional character, or list of characters, to treat as "end" characters.

index.d.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@ declare function pathToRegexp (path: pathToRegexp.Path, keys?: pathToRegexp.Key[
33
declare namespace pathToRegexp {
44
export interface RegExpOptions {
55
/**
6-
* When `true` the route will be case sensitive. (default: `false`)
6+
* When `true` the regexp will be case sensitive. (default: `false`)
77
*/
88
sensitive?: boolean;
99
/**
10-
* When `false` the trailing slash is optional. (default: `false`)
10+
* When `true` the regexp allows an optional trailing delimiter to match. (default: `false`)
1111
*/
1212
strict?: boolean;
1313
/**
14-
* When `false` the path will match at the beginning. (default: `true`)
14+
* When `false` the regexp will match the beginning instead of the entire string. (default: `true`)
1515
*/
1616
end?: boolean;
1717
/**

0 commit comments

Comments
 (0)