Interface PatternBlock<State>

Subset of Masked attributes used with pattern

interface PatternBlock<State> {
    displayValue: string;
    eager?: boolean | "remove" | "append";
    isComplete: boolean;
    isFilled: boolean;
    isFixed?: boolean;
    isOptional?: boolean;
    lazy?: boolean;
    state: any;
    unmaskedValue: string;
    value: string;
    _appendChar(str, flags): ChangeDetails;
    _appendEager(): ChangeDetails;
    _appendPlaceholder(toBlockIndex?): ChangeDetails;
    append(str, flags?, tail?): ChangeDetails;
    appendTail(tail): ChangeDetails;
    doCommit(): void;
    extractInput(fromPos?, toPos?, flags?): string;
    extractTail(fromPos?, toPos?): TailDetails;
    nearestInputPos(cursorPos, direction): number;
    pad(flags?): ChangeDetails;
    remove(fromPos?, toPos?): ChangeDetails;
    reset(): void;
    totalInputPositions(fromPos?, toPos?): number;
}

Type Parameters

State = MaskedState

Implemented by

Properties

`Readonly` displayValue

displayValue: string

`Optional` `Readonly` eager

eager?: boolean | "remove" | "append"

`Readonly` isComplete

isComplete: boolean

`Readonly` isFilled

isFilled: boolean

`Optional` `Readonly` isFixed

isFixed?: boolean

`Optional` `Readonly` isOptional

isOptional?: boolean

`Optional` `Readonly` lazy

lazy?: boolean

state

state: any

`Readonly` unmaskedValue

unmaskedValue: string

`Readonly` value

value: string

Methods

_appendChar

_appendChar(str, flags): ChangeDetails
Parameters
- str: string
- flags: AppendFlags<State>
Returns ChangeDetails
- Defined in masked/pattern/block.ts:27

_appendEager

_appendEager(): ChangeDetails
Returns ChangeDetails
- Defined in masked/pattern/block.ts:29

_appendPlaceholder

_appendPlaceholder(toBlockIndex?): ChangeDetails
Parameters
- Optional toBlockIndex: number
Returns ChangeDetails
- Defined in masked/pattern/block.ts:28

append

append(str, flags?, tail?): ChangeDetails
Parameters
- str: string
- Optional flags: AppendFlags<State>
- Optional tail: TailDetails
Returns ChangeDetails
- Defined in masked/pattern/block.ts:25

appendTail

appendTail(tail): ChangeDetails
Parameters
- tail: string | TailDetails
Returns ChangeDetails
- Defined in masked/pattern/block.ts:26

doCommit

doCommit(): void
Returns void
- Defined in masked/pattern/block.ts:30

extractInput

extractInput(fromPos?, toPos?, flags?): string
Parameters
- Optional fromPos: number
- Optional toPos: number
- Optional flags: ExtractFlags
Returns string
- Defined in masked/pattern/block.ts:23

extractTail

extractTail(fromPos?, toPos?): TailDetails
Parameters
- Optional fromPos: number
- Optional toPos: number
Returns TailDetails
- Defined in masked/pattern/block.ts:24

nearestInputPos

nearestInputPos(cursorPos, direction): number
Parameters
- cursorPos: number
- direction: Direction
Returns number
- Defined in masked/pattern/block.ts:31

pad

pad(flags?): ChangeDetails
Parameters
- Optional flags: AppendFlags<MaskedState>
Returns ChangeDetails
- Defined in masked/pattern/block.ts:33

remove

remove(fromPos?, toPos?): ChangeDetails
Parameters
- Optional fromPos: number
- Optional toPos: number
Returns ChangeDetails
- Defined in masked/pattern/block.ts:22

reset

reset(): void
Returns void
- Defined in masked/pattern/block.ts:21

totalInputPositions

totalInputPositions(fromPos?, toPos?): number
Parameters
- Optional fromPos: number
- Optional toPos: number
Returns number
- Defined in masked/pattern/block.ts:32