ui-router-server / matcher / CompiledMatcher

Interface: CompiledMatcher<M>

Defined in: url-matcher.ts:404

A compiled url pattern: inert data produced by urlMatcherFactory's compile and consumed by exec, format, and compare. Frozen — treat as immutable: compare memoizes per object identity, and the functions/regexps inside make it not structuredClone-able. Two data channels: compile's options.meta rides compile-time data on the matcher, and a consumer-owned identity-keyed WeakMap (frozen keys are fine) covers external or mutable association.

Type Parameters

Type Parameter	Default type
M	undefined

Properties

Property	Modifier	Type	Description	Defined in
decodeParams	readonly	boolean	Whether exec percent-decodes captured values (the factory's decodeParams).	url-matcher.ts:416
meta	readonly	M	Compile-time data riding the matcher (e.g. a build-time route id); the reference is frozen in, the object stays consumer-owned.	url-matcher.ts:418
pathParams	readonly	readonly CompiledParam[]	The path placeholders, in pattern order — what exec reads out of the regexp captures.	url-matcher.ts:412
pattern	readonly	string	The pattern that was compiled.	url-matcher.ts:406
regexp	readonly	RegExp	The whole-path regexp the pattern compiled to.	url-matcher.ts:408
searchParams	readonly	readonly CompiledParam[]	The search placeholders; they never affect path matching, and exec resolves them to their defaults.	url-matcher.ts:414
segments	readonly	readonly string[]	The raw static segments between path params (length: path params + 1).	url-matcher.ts:410