IMaskToken
interface
Mask
Token emitted by the pattern parser. kind describes what character class the token accepts; consumer flags whether the token slots a user character (#, A, *) or is a literal kept verbatim.
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.
- kindrequiredTMaskTokenKind
- Character class accepted by this token. 'digit' matches [0-9], 'letter' matches [a-zA-Z], 'any' matches any char, 'literal' is kept verbatim.
- charrequiredstring
- The raw character from the pattern string (e.g. "#", "A", "*", or a literal like "/").
- consumerrequiredboolean
- True when this token slots a user-typed character; false for literals that are inserted automatically.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Inspecting parsed tokens