Class MaskedDynamic<Value>

Dynamic mask for choosing appropriate mask in run-time

Type Parameters

Value = any

Hierarchy (view full)

Masked<Value>
- MaskedDynamic

Constructors

constructor

new MaskedDynamic<Value>(opts?): MaskedDynamic<Value>
Type Parameters
- Value = any
Parameters
- Optional opts: Partial<Pick<MaskedDynamic<any>, "eager" | "mask" | "parent" | "prepare" | "prepareChar" | "validate" | "commit" | "format" | "parse" | "overwrite" | "skipInvalid" | "autofix" | "dispatch">>
Returns MaskedDynamic<Value>
Overrides Masked.constructor
- Defined in masked/dynamic.ts:86

Properties

`Optional` _autofix

_autofix?: boolean | "pad"

`Optional` _eager

_eager?: boolean | "remove" | "append"

_initialized

_initialized: boolean

`Optional` _isolated

_isolated?: boolean

`Optional` _overwrite

_overwrite?: boolean | "shift"

`Optional` _refreshing

_refreshing?: boolean

`Optional` _skipInvalid

_skipInvalid?: boolean

_value

_value: string

`Optional` commit

commit?: ((value, masked) => void)

Does additional processing at the end of editing

Type declaration

- (value, masked): void
- Parameters
  - value: string
  - masked: Masked<any>
  Returns void

compiledMasks

compiledMasks: Masked<any>[]

Compliled Masked options

`Optional` currentMask

currentMask?: Masked<any>

Currently chosen mask

dispatch

dispatch: ((appended, masked, flags, tail) => undefined | Masked<any>)

Chooses Masked depending on input value

Type declaration

- (appended, masked, flags, tail): undefined | Masked<any>
- Parameters
  - appended: string
  - masked: MaskedDynamic<any>
  - flags: AppendFlags<HandleState>
  - tail: string | String | TailDetails
  Returns undefined | Masked<any>

`Optional` exposeMask

exposeMask?: Masked<any>

Currently chosen mask

`Optional` format

format?: ((value, masked) => string)

Format typed value to string

Type declaration

- (value, masked): string
- Parameters
  - value: Value
  - masked: Masked<any>
  Returns string

mask

mask: DynamicMaskType

`Optional` parent

parent?: Masked<any>

`Optional` parse

parse?: ((str, masked) => Value)

Parse string to get typed value

Type declaration

- (str, masked): Value
- Parameters
  - str: string
  - masked: Masked<any>
  Returns Value

`Optional` prepare

prepare?: ((chars, masked, flags) => string | [string, ChangeDetails])

Transforms value before mask processing

Type declaration

- (chars, masked, flags): string | [string, ChangeDetails]
- Parameters
  - chars: string
  - masked: Masked<any>
  - flags: AppendFlags<MaskedState>
  Returns string | [string, ChangeDetails]

`Optional` prepareChar

prepareChar?: ((chars, masked, flags) => string | [string, ChangeDetails])

Transforms each char before mask processing

Type declaration

- (chars, masked, flags): string | [string, ChangeDetails]
- Parameters
  - chars: string
  - masked: Masked<any>
  - flags: AppendFlags<MaskedState>
  Returns string | [string, ChangeDetails]

`Optional` validate

validate?: ((value, masked, flags) => boolean)

Validates if value is acceptable

Type declaration

- (value, masked, flags): boolean
- Parameters
  - value: string
  - masked: Masked<any>
  - flags: AppendFlags<MaskedState>
  Returns boolean

`Static` DEFAULTS

`Static` EMPTY_VALUES

EMPTY_VALUES: any[] = ...

Accessors

autofix

get autofix(): undefined | boolean | "pad"
Returns undefined | boolean | "pad"
Overrides Masked.autofix
- Defined in masked/dynamic.ts:406
set autofix(autofix): void
Parameters
- autofix: undefined | boolean | "pad"
Returns void
Overrides Masked.autofix
- Defined in masked/dynamic.ts:412

displayValue

get displayValue(): string
Returns string
Overrides Masked.displayValue
- Defined in masked/dynamic.ts:309

eager

get eager(): undefined | boolean | "remove" | "append"
Returns undefined | boolean | "remove" | "append"
Overrides Masked.eager
- Defined in masked/dynamic.ts:386
set eager(eager): void
Parameters
- eager: undefined | boolean | "remove" | "append"
Returns void
Overrides Masked.eager
- Defined in masked/dynamic.ts:392

isComplete

get isComplete(): boolean
Returns boolean
Overrides Masked.isComplete
- Defined in masked/dynamic.ts:313

isFilled

get isFilled(): boolean
Returns boolean
Overrides Masked.isFilled
- Defined in masked/dynamic.ts:317

overwrite

get overwrite(): undefined | boolean | "shift"
Enable characters overwriting

Returns undefined | boolean | "shift"
Overrides Masked.overwrite
- Defined in masked/dynamic.ts:376
set overwrite(overwrite): void
Enable characters overwriting
Parameters
- overwrite: undefined | boolean | "shift"
Returns void
Overrides Masked.overwrite
- Defined in masked/dynamic.ts:382

rawInputValue

get rawInputValue(): string
Value that includes raw user input

Returns string
Inherited from Masked.rawInputValue
- Defined in masked/base.ts:163
set rawInputValue(value): void
Parameters
- value: string
Returns void
Inherited from Masked.rawInputValue
- Defined in masked/base.ts:167

skipInvalid

get skipInvalid(): undefined | boolean
Returns undefined | boolean
Overrides Masked.skipInvalid
- Defined in masked/dynamic.ts:396
set skipInvalid(skipInvalid): void
Parameters
- skipInvalid: undefined | boolean
Returns void
Overrides Masked.skipInvalid
- Defined in masked/dynamic.ts:402

state

get state(): MaskedDynamicState
Mask state

Returns MaskedDynamicState
Overrides Masked.state
- Defined in masked/dynamic.ts:333
set state(state): void
Parameters
- state: HandleState
Returns void
Overrides Masked.state
- Defined in masked/dynamic.ts:343

typedValue

get typedValue(): Value
Returns Value
Overrides Masked.typedValue
- Defined in masked/dynamic.ts:285
set typedValue(typedValue): void
Parameters
- typedValue: Value
Returns void
Overrides Masked.typedValue
- Defined in masked/dynamic.ts:291

unmaskedValue

get unmaskedValue(): string
Returns string
Overrides Masked.unmaskedValue
- Defined in masked/dynamic.ts:270
set unmaskedValue(unmaskedValue): void
Parameters
- unmaskedValue: string
Returns void
Overrides Masked.unmaskedValue
- Defined in masked/dynamic.ts:276

value

get value(): string
Returns string
Overrides Masked.value
- Defined in masked/dynamic.ts:255
set value(value): void
Parameters
- value: string
Returns void
Overrides Masked.value
- Defined in masked/dynamic.ts:261

Methods

_appendChar

_appendChar(ch, flags?, checkTail?): ChangeDetails
Appends char
Parameters
- ch: string
- flags: AppendFlags<MaskedState> = {}
- Optional checkTail: TailDetails
Returns ChangeDetails
Inherited from Masked._appendChar
- Defined in masked/base.ts:221

_appendCharRaw

_appendCharRaw(ch, flags?): ChangeDetails
Appends char
Parameters
- ch: string
- flags: AppendFlags<HandleState> = {}
Returns ChangeDetails
Overrides Masked._appendCharRaw
- Defined in masked/dynamic.ts:126

_appendEager

_appendEager(): ChangeDetails
Appends optional eager placeholder at the end

Returns ChangeDetails
Overrides Masked._appendEager
- Defined in masked/dynamic.ts:187

_appendPlaceholder

_appendPlaceholder(): ChangeDetails
Appends optional placeholder at the end

Returns ChangeDetails
Overrides Masked._appendPlaceholder
- Defined in masked/dynamic.ts:177

_applyDispatch

_applyDispatch(appended?, flags?, tail?): ChangeDetails
Parameters
- appended: string = ''
- flags: AppendFlags<HandleState> = {}
- tail: string | String | TailDetails = ''
Returns ChangeDetails
- Defined in masked/dynamic.ts:136

_update

_update(opts): void
Sets new options
Parameters
- opts: Partial<Partial<Pick<MaskedDynamic<any>, "eager" | "mask" | "parent" | "prepare" | "prepareChar" | "validate" | "commit" | "format" | "parse" | "overwrite" | "skipInvalid" | "autofix" | "dispatch">>>
Returns void
Overrides Masked._update
- Defined in masked/dynamic.ts:99

append

append(str, flags?, tail?): ChangeDetails
Appends symbols considering flags
Parameters
- str: string
- Optional flags: AppendFlags<MaskedState>
- Optional tail: string | String | TailDetails
Returns ChangeDetails
Inherited from Masked.append
- Defined in masked/base.ts:304

appendTail

appendTail(tail): ChangeDetails
Appends tail
Parameters
- tail: string | String | TailDetails
Returns ChangeDetails
Overrides Masked.appendTail
- Defined in masked/dynamic.ts:197

currentMaskFlags

currentMaskFlags(flags): AppendFlags<MaskedState>
Parameters
- flags: AppendFlags<HandleState>
Returns AppendFlags<MaskedState>
- Defined in masked/dynamic.ts:206

doCommit

doCommit(): void
Does additional processing at the end of editing

Returns void
Overrides Masked.doCommit
- Defined in masked/dynamic.ts:365

doDispatch

doDispatch(appended, flags?, tail?): undefined | Masked<any>
Parameters
- appended: string
- flags: AppendFlags<HandleState> = {}
- tail: string | String | TailDetails = ''
Returns undefined | Masked<any>
- Defined in masked/dynamic.ts:216

doPrepare

doPrepare(str, flags?): [string, ChangeDetails]
Prepares string before mask processing
Parameters
- str: string
- flags: AppendFlags<HandleState> = {}
Returns [string, ChangeDetails]
Overrides Masked.doPrepare
- Defined in masked/dynamic.ts:226

doPrepareChar

doPrepareChar(str, flags?): [string, ChangeDetails]
Prepares each char before mask processing
Parameters
- str: string
- flags: AppendFlags<HandleState> = {}
Returns [string, ChangeDetails]
Overrides Masked.doPrepareChar
- Defined in masked/dynamic.ts:238

doSkipInvalid

doSkipInvalid(ch, flags?, checkTail?): boolean
Parameters
- ch: string
- flags: AppendFlags<MaskedState> = {}
- Optional checkTail: TailDetails
Returns boolean
Inherited from Masked.doSkipInvalid
- Defined in masked/base.ts:372

doValidate

doValidate(flags): boolean
Validates if value is acceptable
Parameters
- flags: AppendFlags<HandleState>
Returns boolean
Overrides Masked.doValidate
- Defined in masked/dynamic.ts:220

extractInput

extractInput(fromPos?, toPos?, flags?): string
Extracts value in range considering flags
Parameters
- Optional fromPos: number
- Optional toPos: number
- Optional flags: ExtractFlags
Returns string
Overrides Masked.extractInput
- Defined in masked/dynamic.ts:353

extractTail

extractTail(fromPos?, toPos?): TailDetails
Extracts tail in range
Parameters
- Optional fromPos: number
- Optional toPos: number
Returns TailDetails
Overrides Masked.extractTail
- Defined in masked/dynamic.ts:359

maskEquals

maskEquals(mask): boolean
Parameters
- mask: any
Returns boolean
Overrides Masked.maskEquals
- Defined in masked/dynamic.ts:416

nearestInputPos

nearestInputPos(cursorPos, direction?): number
Finds nearest input position in direction
Parameters
- cursorPos: number
- Optional direction: Direction
Returns number
Overrides Masked.nearestInputPos
- Defined in masked/dynamic.ts:370

optionsIsChanged

optionsIsChanged(opts): boolean
Parameters
- opts: Partial<Partial<Pick<Masked<any>, "eager" | "mask" | "parent" | "prepare" | "prepareChar" | "validate" | "commit" | "format" | "parse" | "overwrite" | "skipInvalid" | "autofix">>>
Returns boolean
Inherited from Masked.optionsIsChanged
- Defined in masked/base.ts:450

pad

pad(flags?): ChangeDetails
Parameters
- Optional flags: AppendFlags<MaskedState>
Returns ChangeDetails
Inherited from Masked.pad
- Defined in masked/base.ts:462

remove

remove(fromPos?, toPos?): ChangeDetails
Parameters
- Optional fromPos: number
- Optional toPos: number
Returns ChangeDetails
Overrides Masked.remove
- Defined in masked/dynamic.ts:321

reset

reset(): void
Resets value

Returns void
Overrides Masked.reset
- Defined in masked/dynamic.ts:250

resolve

resolve(value, flags?): void
Resolve new value
Parameters
- value: string
- flags: AppendFlags<MaskedState> = ...
Returns void
Inherited from Masked.resolve
- Defined in masked/base.ts:136

runIsolated

runIsolated<T>(fn): T
Type Parameters
- T
Parameters
- fn: ((masked) => T)
  - - (masked): T
    - Parameters
      masked: this
      Returns T
Returns T
Inherited from Masked.runIsolated
- Defined in masked/base.ts:359

splice

splice(start, deleteCount, inserted?, removeDirection?, flags?): ChangeDetails
Parameters
- start: number
- deleteCount: number
- inserted: string = ''
- removeDirection: Direction = DIRECTION.NONE
- flags: AppendFlags<MaskedState> = ...
Returns ChangeDetails
Inherited from Masked.splice
- Defined in masked/base.ts:401

totalInputPositions

totalInputPositions(fromPos?, toPos?): number
Parameters
- fromPos: number = 0
- toPos: number = ...
Returns number
Inherited from Masked.totalInputPositions
- Defined in masked/base.ts:188

typedValueEquals

typedValueEquals(value): boolean
Parameters
- value: any
Returns boolean
Overrides Masked.typedValueEquals
- Defined in masked/dynamic.ts:426

updateOptions

updateOptions(opts): void
Sets and applies new options
Parameters
- opts: Partial<Partial<Pick<MaskedDynamic<any>, "eager" | "mask" | "parent" | "prepare" | "prepareChar" | "validate" | "commit" | "format" | "parse" | "overwrite" | "skipInvalid" | "autofix" | "dispatch">>>
Returns void
Overrides Masked.updateOptions
- Defined in masked/dynamic.ts:95

withValueRefresh

withValueRefresh<T>(fn): T
Calls function and reapplies current value
Type Parameters
- T
Parameters
- fn: (() => T)
  - - (): T
    - Returns T
Returns T
Inherited from Masked.withValueRefresh
- Defined in masked/base.ts:339

Class MaskedDynamic<Value>

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns MaskedDynamic<Value>

Properties

Optional _autofix

Optional _eager

_initialized

Optional _isolated

Optional _overwrite

Optional _refreshing

Optional _skipInvalid

_value

Optional commit

Type declaration

Parameters

Returns void

compiledMasks

Optional currentMask

dispatch

Type declaration

Parameters

Returns undefined | Masked<any>

Optional exposeMask

Optional format

Type declaration

Parameters

Returns string

mask

Optional parent

Optional parse

Type declaration

Parameters

Returns Value

Optional prepare

Type declaration

Parameters

Returns string | [string, ChangeDetails]

Optional prepareChar

Type declaration

Parameters

Returns string | [string, ChangeDetails]

Optional validate

Type declaration

Parameters

Returns boolean

Static DEFAULTS

Static EMPTY_VALUES

Accessors

autofix

Returns undefined | boolean | "pad"

Parameters

Returns void

displayValue

Returns string

eager

Returns undefined | boolean | "remove" | "append"

Parameters

Returns void

isComplete

Returns boolean

isFilled

Returns boolean

overwrite

Returns undefined | boolean | "shift"

Parameters

Returns void

rawInputValue

Returns string

Parameters

Returns void

`Optional` _autofix

`Optional` _eager

`Optional` _isolated

`Optional` _overwrite

`Optional` _refreshing

`Optional` _skipInvalid

`Optional` commit

`Optional` currentMask

`Optional` exposeMask

`Optional` format

`Optional` parent

`Optional` parse

`Optional` prepare

`Optional` prepareChar

`Optional` validate

`Static` DEFAULTS

`Static` EMPTY_VALUES