Class MaskedFunction<Value>

Masking by custom Function

Type Parameters

Value = any

Hierarchy (view full)

Masked<Value>
- MaskedFunction

Constructors

constructor

new MaskedFunction<Value>(opts): MaskedFunction<Value>
Type Parameters
- Value = any
Parameters
- opts: Partial<Pick<Masked<any>, "eager" | "mask" | "parent" | "prepare" | "prepareChar" | "validate" | "commit" | "format" | "parse" | "overwrite" | "skipInvalid" | "autofix">>
Returns MaskedFunction<Value>
Inherited from Masked.constructor
- Defined in masked/base.ts:89

Properties

_initialized

_initialized: boolean

`Optional` _isolated

_isolated?: boolean

`Optional` _refreshing

_refreshing?: boolean

_value

_value: string

`Optional` autofix

autofix?: boolean | "pad"

`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

`Optional` eager

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

`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: ((value, masked) => boolean)

Type declaration

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

`Optional` overwrite

overwrite?: boolean | "shift"

Enable characters overwriting

`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` skipInvalid

skipInvalid?: boolean

`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

displayValue

get displayValue(): string
Returns string
Inherited from Masked.displayValue
- Defined in masked/base.ts:171

isComplete

get isComplete(): boolean
Returns boolean
Inherited from Masked.isComplete
- Defined in masked/base.ts:175

isFilled

get isFilled(): boolean
Returns boolean
Inherited from Masked.isFilled
- Defined in masked/base.ts:179

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

state

get state(): MaskedState
Mask state

Returns MaskedState
Inherited from Masked.state
- Defined in masked/base.ts:111
set state(state): void
Parameters
- state: MaskedState
Returns void
Inherited from Masked.state
- Defined in masked/base.ts:118

typedValue

get typedValue(): Value
Returns Value
Inherited from Masked.typedValue
- Defined in masked/base.ts:150
set typedValue(value): void
Parameters
- value: Value
Returns void
Inherited from Masked.typedValue
- Defined in masked/base.ts:154

unmaskedValue

get unmaskedValue(): string
Returns string
Inherited from Masked.unmaskedValue
- Defined in masked/base.ts:142
set unmaskedValue(value): void
Parameters
- value: string
Returns void
Inherited from Masked.unmaskedValue
- Defined in masked/base.ts:146

value

get value(): string
Returns string
Inherited from Masked.value
- Defined in masked/base.ts:127
set value(value): void
Parameters
- value: string
Returns void
Inherited from Masked.value
- Defined in masked/base.ts:131

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<MaskedState> = {}
Returns ChangeDetails
Inherited from Masked._appendCharRaw
- Defined in masked/base.ts:210

_appendEager

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

Returns ChangeDetails
Inherited from Masked._appendEager
- Defined in masked/base.ts:299

_appendPlaceholder

_appendPlaceholder(): ChangeDetails
Appends optional placeholder at the end

Returns ChangeDetails
Inherited from Masked._appendPlaceholder
- Defined in masked/base.ts:294

_update

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

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
Inherited from Masked.appendTail
- Defined in masked/base.ts:203

doCommit

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

Returns void
Inherited from Masked.doCommit
- Defined in masked/base.ts:397

doPrepare

doPrepare(str, flags?): [string, ChangeDetails]
Prepares string before mask processing
Parameters
- str: string
- flags: AppendFlags<MaskedState> = {}
Returns [string, ChangeDetails]
Inherited from Masked.doPrepare
- Defined in masked/base.ts:377

doPrepareChar

doPrepareChar(str, flags?): [string, ChangeDetails]
Prepares each char before mask processing
Parameters
- str: string
- flags: AppendFlags<MaskedState> = {}
Returns [string, ChangeDetails]
Inherited from Masked.doPrepareChar
- Defined in masked/base.ts:384

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<MaskedState>
Returns boolean
Inherited from Masked.doValidate
- Defined in masked/base.ts:391

extractInput

extractInput(fromPos?, toPos?, flags?): string
Extracts value in range considering flags
Parameters
- fromPos: number = 0
- toPos: number = ...
- Optional flags: ExtractFlags
Returns string
Inherited from Masked.extractInput
- Defined in masked/base.ts:193

extractTail

extractTail(fromPos?, toPos?): TailDetails
Extracts tail in range
Parameters
- fromPos: number = 0
- toPos: number = ...
Returns TailDetails
Inherited from Masked.extractTail
- Defined in masked/base.ts:198

maskEquals

maskEquals(mask): boolean
Parameters
- mask: any
Returns boolean
Inherited from Masked.maskEquals
- Defined in masked/base.ts:446

nearestInputPos

nearestInputPos(cursorPos, direction?): number
Finds nearest input position in direction
Parameters
- cursorPos: number
- Optional direction: Direction
Returns number
Inherited from Masked.nearestInputPos
- Defined in masked/base.ts:184

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
- fromPos: number = 0
- toPos: number = ...
Returns ChangeDetails
Inherited from Masked.remove
- Defined in masked/base.ts:333

reset

reset(): void
Resets value

Returns void
Inherited from Masked.reset
- Defined in masked/base.ts:123

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
Inherited from Masked.typedValueEquals
- Defined in masked/base.ts:454

updateOptions

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

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 MaskedFunction<Value>

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns MaskedFunction<Value>

Properties

_initialized

Optional _isolated

Optional _refreshing

_value

Optional autofix

Optional commit

Type declaration

Parameters

Returns void

Optional eager

Optional format

Type declaration

Parameters

Returns string

mask

Type declaration

Parameters

Returns boolean

Optional overwrite

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 skipInvalid

Optional validate

Type declaration

Parameters

Returns boolean

Static DEFAULTS

Static EMPTY_VALUES

Accessors

displayValue

Returns string

isComplete

Returns boolean

isFilled

Returns boolean

rawInputValue

Returns string

Parameters

Returns void

state

Returns MaskedState

Parameters

Returns void

typedValue

Returns Value

Parameters

Returns void

unmaskedValue

Returns string

Parameters

Returns void

value

Returns string

Parameters

Returns void

`Optional` _isolated

`Optional` _refreshing

`Optional` autofix

`Optional` commit

`Optional` eager

`Optional` format

`Optional` overwrite

`Optional` parent

`Optional` parse

`Optional` prepare

`Optional` prepareChar

`Optional` skipInvalid

`Optional` validate

`Static` DEFAULTS

`Static` EMPTY_VALUES