Class MaskedPattern<Value>

Pattern mask

Type Parameters

Value = string

Hierarchy (view full)

Masked<Value>
- MaskedPattern

Index

Constructors

constructor

Accessors

displayValue isComplete isFilled isFixed isOptional rawInputValue state typedValue unmaskedValue value

Constructors

constructor

new MaskedPattern<Value>(opts): MaskedPattern<Value>
Type Parameters
- Value = string
Parameters
- opts: Partial<Pick<MaskedPattern<Value>, "eager" | "mask" | "parent" | "prepare" | "prepareChar" | "validate" | "commit" | "format" | "parse" | "overwrite" | "skipInvalid" | "autofix" | "definitions" | "blocks" | "placeholderChar" | "displayChar" | "lazy">>
Returns MaskedPattern<Value>
Overrides Masked.constructor
- Defined in masked/pattern.ts:90

Properties

_blocks

_blocks: PatternBlock<MaskedState>[]

_initialized

_initialized: boolean

`Optional` _isolated

_isolated?: boolean

_maskedBlocks

_maskedBlocks: {
[key: string]: number[];
}

Type declaration

[key: string]: number[]

`Optional` _refreshing

_refreshing?: boolean

_stops

_stops: number[]

_value

_value: string

`Optional` autofix

autofix?: boolean | "pad"

blocks

blocks: {
[key: string]: ExtendFactoryArgOptions<BlockExtraOptions>;
}

Type declaration

[key: string]: ExtendFactoryArgOptions<BlockExtraOptions>

`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

definitions

definitions: Definitions

displayChar

displayChar: string

Single char for filled input

`Optional` eager

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

`Optional` exposeBlock

exposeBlock?: Masked<any>

`Optional` format

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

Format typed value to string

Type declaration

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

lazy

lazy: boolean

Show placeholder only when needed

mask

mask: string

`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

placeholderChar

placeholderChar: string

Single char for empty input

`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

DEFAULTS: {
    lazy: boolean;
    placeholderChar: string;
    skipInvalid?: boolean;
} = ...

Type declaration

lazy: boolean
placeholderChar: string
Optional Abstract skipInvalid?: boolean

`Static` EMPTY_VALUES

EMPTY_VALUES: any[] = ...

`Static` ESCAPE_CHAR

ESCAPE_CHAR: string = '\\'

`Static` FixedDefinition

FixedDefinition: typeof PatternFixedDefinition = PatternFixedDefinition

`Static` InputDefinition

InputDefinition: typeof PatternInputDefinition = PatternInputDefinition

`Static` STOP_CHAR

STOP_CHAR: string = '`'

Accessors

displayValue

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

isComplete

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

isFilled

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

isFixed

get isFixed(): boolean
Returns boolean
- Defined in masked/pattern.ts:231

isOptional

get isOptional(): boolean
Returns boolean
- Defined in masked/pattern.ts:235

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(): MaskedPatternState
Mask state

Returns MaskedPatternState
Overrides Masked.state
- Defined in masked/pattern.ts:202
set state(state): void
Parameters
- state: MaskedPatternState
Returns void
Overrides Masked.state
- Defined in masked/pattern.ts:209

typedValue

get typedValue(): Value
Returns Value
Overrides Masked.typedValue
- Defined in masked/pattern.ts:275
set typedValue(value): void
Parameters
- value: Value
Returns void
Overrides Masked.typedValue
- Defined in masked/pattern.ts:280

unmaskedValue

get unmaskedValue(): string
Returns string
Overrides Masked.unmaskedValue
- Defined in masked/pattern.ts:244
set unmaskedValue(unmaskedValue): void
Parameters
- unmaskedValue: string
Returns void
Overrides Masked.unmaskedValue
- Defined in masked/pattern.ts:249

value

get value(): string
Returns string
Overrides Masked.value
- Defined in masked/pattern.ts:259
set value(value): void
Parameters
- value: string
Returns void
Overrides Masked.value
- Defined in masked/pattern.ts:265

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<MaskedPatternState> = {}
Returns ChangeDetails
Overrides Masked._appendCharRaw
- Defined in masked/pattern.ts:317

_appendEager

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

Returns ChangeDetails
Overrides Masked._appendEager
- Defined in masked/pattern.ts:298

_appendPlaceholder

_appendPlaceholder(toBlockIndex?): ChangeDetails
Appends placeholder depending on laziness
Parameters
- Optional toBlockIndex: number
Returns ChangeDetails
Overrides Masked._appendPlaceholder
- Defined in masked/pattern.ts:372

_blockStartPos

_blockStartPos(blockIndex): number
Parameters
- blockIndex: number
Returns number
- Defined in masked/pattern.ts:410

_findStopBefore

_findStopBefore(blockIndex): undefined | number
Parameters
- blockIndex: number
Returns undefined | number
- Defined in masked/pattern.ts:361

_forEachBlocksInRange

_forEachBlocksInRange(fromPos, toPos?, fn): void
Parameters
- fromPos: number
- toPos: number = ...
- fn: ((block, blockIndex, fromPos, toPos) => void)
  - - (block, blockIndex, fromPos, toPos): void
    - Parameters
      block: PatternBlock<MaskedState>
      blockIndex: number
      fromPos: number
      toPos: number
      Returns void
Returns void
- Defined in masked/pattern.ts:416

_mapPosToBlock

_mapPosToBlock(pos): undefined | BlockPosData
Finds block in pos
Parameters
- pos: number
Returns undefined | BlockPosData
- Defined in masked/pattern.ts:393

_rebuildMask

_rebuildMask(): void
Returns void
- Defined in masked/pattern.ts:108

_update

_update(opts): void
Sets new options
Parameters
- opts: Partial<Partial<Pick<MaskedPattern<Value>, "eager" | "mask" | "parent" | "prepare" | "prepareChar" | "validate" | "commit" | "format" | "parse" | "overwrite" | "skipInvalid" | "autofix" | "definitions" | "blocks" | "placeholderChar" | "displayChar" | "lazy">>>
Returns void
Overrides Masked._update
- Defined in masked/pattern.ts:102

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/pattern.ts:294

doCommit

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

Returns void
Overrides Masked.doCommit
- Defined in masked/pattern.ts:239

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 = ...
- flags: ExtractFlags = {}
Returns string
Overrides Masked.extractInput
- Defined in masked/pattern.ts:349

extractTail

extractTail(fromPos?, toPos?): TailDetails
Extracts tail in range
Parameters
- fromPos: number = 0
- toPos: number = ...
Returns TailDetails
Overrides Masked.extractTail
- Defined in masked/pattern.ts:333

maskEquals

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

maskedBlock

maskedBlock(name): undefined | PatternBlock<MaskedState>
Get block by name
Parameters
- name: string
Returns undefined | PatternBlock<MaskedState>
- Defined in masked/pattern.ts:528

maskedBlocks

maskedBlocks(name): PatternBlock<MaskedState>[]
Get all blocks by name
Parameters
- name: string
Returns PatternBlock<MaskedState>[]
- Defined in masked/pattern.ts:533

nearestInputPos

nearestInputPos(cursorPos, direction?): number
Finds nearest input position in direction
Parameters
- cursorPos: number
- direction: Direction = DIRECTION.NONE
Returns number
Overrides Masked.nearestInputPos
- Defined in masked/pattern.ts:449

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
Overrides Masked.pad
- Defined in masked/pattern.ts:539

remove

remove(fromPos?, toPos?): ChangeDetails
Parameters
- fromPos: number = 0
- toPos: number = ...
Returns ChangeDetails
Overrides Masked.remove
- Defined in masked/pattern.ts:441

reset

reset(): void
Resets value

Returns void
Overrides Masked.reset
- Defined in masked/pattern.ts:217

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
Overrides Masked.totalInputPositions
- Defined in masked/pattern.ts:519

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<MaskedPattern<Value>, "eager" | "mask" | "parent" | "prepare" | "prepareChar" | "validate" | "commit" | "format" | "parse" | "overwrite" | "skipInvalid" | "autofix" | "definitions" | "blocks" | "placeholderChar" | "displayChar" | "lazy">>>
Returns void
Overrides Masked.updateOptions
- Defined in masked/pattern.ts:98

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

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns MaskedPattern<Value>

Properties

_blocks

_initialized

Optional _isolated

_maskedBlocks

Type declaration

[key: string]: number[]

Optional _refreshing

_stops

_value

Optional autofix

blocks

Type declaration

[key: string]: ExtendFactoryArgOptions<BlockExtraOptions>

Optional commit

Type declaration

Parameters

Returns void

definitions

displayChar

Optional eager

Optional exposeBlock

Optional format

Type declaration

Parameters

Returns string

lazy

mask

Optional overwrite

Optional parent

Optional parse

Type declaration

Parameters

Returns Value

placeholderChar

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

Type declaration

lazy: boolean

placeholderChar: string

Optional Abstract skipInvalid?: boolean

Static EMPTY_VALUES

Static ESCAPE_CHAR

Static FixedDefinition

Static InputDefinition

Static STOP_CHAR

Accessors

displayValue

Returns string

isComplete

Returns boolean

isFilled

Returns boolean

isFixed

Returns boolean

`Optional` _isolated

`Optional` _refreshing

`Optional` autofix

`Optional` commit

`Optional` eager

`Optional` exposeBlock

`Optional` format

`Optional` overwrite

`Optional` parent

`Optional` parse

`Optional` prepare

`Optional` prepareChar

`Optional` skipInvalid

`Optional` validate

`Static` DEFAULTS

`Optional` `Abstract` skipInvalid?: boolean

`Static` EMPTY_VALUES

`Static` ESCAPE_CHAR

`Static` FixedDefinition

`Static` InputDefinition

`Static` STOP_CHAR