IMaskApplyResult
interface
Mask
Output shape of applyMask — masked is the formatted display string with literals interleaved; unmasked is the raw user-provided characters (consumer slots only); complete signals that all consumer tokens are filled.
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.
- maskedrequiredstring
- Formatted display string with pattern literals interleaved (e.g. "12/34/5678").
- unmaskedrequiredstring
- Raw user-provided characters with no literal separators (e.g. "12345678").
- completerequiredboolean
- True when every consumer token (#, A, *) in the pattern has been filled.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Reading the result of applyMask