Interface: PatternParam
API / @xmachines/play-pattern / PatternParam
Defined in: pattern-grammar.ts:101
One named param of a pattern, with the question that every caller asks about it.
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
groupName | readonly | string | The name that URLPattern compiles, for example cat_id. | pattern-grammar.ts:105 |
name | readonly | string | The name as the pattern declares it, for example cat-id. | pattern-grammar.ts:103 |
optional | readonly | boolean | True when a matching path can carry no value for this param. The modifier ? and the modifier * make a param optional, and so does EVERY group above it that carries one of the two. The modifier + does not: it repeats a param that one value must still fill. | pattern-grammar.ts:113 |