IResolvedMaskConfig
interface
Form & Input
Normalised mask configuration returned by resolveMaskConfig after accepting a raw string pattern, a preset key, or an IMaskOptions object as input. At this layer the pattern is always a raw template string and every field is guaranteed non-optional.
TypeScript
Definition
The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- patternrequiredstring
- Raw token-walker template string. # = digit, A = letter, * = any char, other characters are literals.
- validatorrequiredTPatternValidator | null
- Optional secondary validation function applied to the unmasked value. null when no validator was provided.
- requiredrequiredboolean
- When true, isValid returns false until every consumer token in the pattern is filled.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Consuming a resolved mask config in useMask