Skip to content

ui-router-server / matcher / ParamType

Interface: ParamType

Defined in: url-matcher.ts:43

The pieces of a ui-router ParamType that path matching and url formatting exercise, with core's member signatures. Relaxation vs core: a plain object suffices (core wants its ParamType class), pattern is required, and name is carried here (the class holds it upstream). encode and equals, when omitted, fall back to core's ParamType class defaults (identity encode, loose equality).

Extends

  • Readonly<Pick<ParamTypeDefinition, "is" | "decode" | "raw">>.Readonly<Required<Pick<ParamTypeDefinition, "pattern">>>

Properties

PropertyModifierTypeDescriptionDefined in
encode?readonly(val) => string | string[] | null | undefinedRelaxation vs core: may return null/undefined, which format() renders as an absent value (core's built-ins do the same at runtime).url-matcher.ts:49
equals?readonly(a, b) => booleanRelaxation vs core: optional here (core's class always carries one).url-matcher.ts:51
namereadonlystring-url-matcher.ts:47