Class MaskedNumber

Number mask

Hierarchy (view full)

Masked<number>
- MaskedNumber

Index

Constructors

constructor

Accessors

allowNegative allowPositive displayValue isComplete isFilled number rawInputValue state typedValue unmaskedValue value

Constructors

constructor

new MaskedNumber(opts?): MaskedNumber
Parameters
- Optional opts: Partial<Pick<MaskedNumber, "eager" | "mask" | "parent" | "prepare" | "prepareChar" | "validate" | "commit" | "format" | "parse" | "overwrite" | "skipInvalid" | "autofix" | "min" | "max" | "radix" | "thousandsSeparator" | "mapToRadix" | "scale" | "normalizeZeros" | "padFractionalZeros">>
Returns MaskedNumber
Overrides Masked.constructor
- Defined in masked/number.ts:76

Properties

_initialized

_initialized: boolean

`Optional` _isolated

_isolated?: boolean

_mapToRadixRegExp

_mapToRadixRegExp: RegExp

_numberRegExp

_numberRegExp: RegExp

`Optional` _refreshing

_refreshing?: boolean

_separatorsProcessed

_separatorsProcessed: boolean

_thousandsSeparatorRegExp

_thousandsSeparatorRegExp: RegExp

_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"

format

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

Format typed value to string

Type declaration

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

mapToRadix

mapToRadix: string[]

Array of single chars

mask

mask: NumberConstructor

max

max: number

min

min: number

normalizeZeros

normalizeZeros: boolean

Flag to remove leading and trailing zeros in the end of editing

`Optional` overwrite

overwrite?: boolean | "shift"

Enable characters overwriting

padFractionalZeros

padFractionalZeros: boolean

Flag to pad trailing zeros after point in the end of editing

`Optional` parent

parent?: Masked<any>

parse

parse: ((str, masked) => number)

Parse string to get typed value

Type declaration

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

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

radix

radix: string

Single char

scale

scale: number

Digits after point

`Optional` skipInvalid

skipInvalid?: boolean

thousandsSeparator

thousandsSeparator: string

Single char

`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: {
    format: ((n) => string);
    mapToRadix: string[];
    mask: NumberConstructor;
    max: number;
    min: number;
    normalizeZeros: boolean;
    padFractionalZeros: boolean;
    parse: NumberConstructor;
    radix: string;
    scale: number;
    skipInvalid?: boolean;
    thousandsSeparator: string;
} = ...

Type declaration

format: ((n) => string)
- - (n): string
  - Parameters
    - n: number
    Returns string
mapToRadix: string[]
mask: NumberConstructor
max: number
min: number
normalizeZeros: boolean
padFractionalZeros: boolean
parse: NumberConstructor
radix: string
scale: number
Optional Abstract skipInvalid?: boolean
thousandsSeparator: string

`Static` EMPTY_VALUES

EMPTY_VALUES: (undefined | null | string | number)[] = ...

`Static` UNMASKED_RADIX

UNMASKED_RADIX: string = '.'

Accessors

allowNegative

get allowNegative(): boolean
Returns boolean
- Defined in masked/number.ts:362

allowPositive

get allowPositive(): boolean
Returns boolean
- Defined in masked/number.ts:366

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

number

get number(): number
Parsed Number

Returns number
- Defined in masked/number.ts:354
set number(number): void
Parameters
- number: number
Returns void
- Defined in masked/number.ts:358

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(): number
Returns number
Overrides Masked.typedValue
- Defined in masked/number.ts:345
set typedValue(n): void
Parameters
- n: number
Returns void
Overrides Masked.typedValue
- Defined in masked/number.ts:349

unmaskedValue

get unmaskedValue(): string
Returns string
Overrides Masked.unmaskedValue
- Defined in masked/number.ts:336
set unmaskedValue(unmaskedValue): void
Parameters
- unmaskedValue: string
Returns void
Overrides Masked.unmaskedValue
- Defined in masked/number.ts:341

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

_adjustRangeWithSeparators

_adjustRangeWithSeparators(from, to): [number, number]
Parameters
- from: number
- to: number
Returns [number, number]
- Defined in masked/number.ts:224

_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
Overrides Masked._appendCharRaw
- Defined in masked/number.ts:161

_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

_findSeparatorAround

_findSeparatorAround(pos): number
Parameters
- pos: number
Returns number
- Defined in masked/number.ts:214

_insertThousandsSeparators

_insertThousandsSeparators(value): string
Parameters
- value: string
Returns string
- Defined in masked/number.ts:108

_normalizeZeros

_normalizeZeros(value): string
Parameters
- value: string
Returns string
- Defined in masked/number.ts:302

_padFractionalZeros

_padFractionalZeros(value): string
Parameters
- value: string
Returns string
- Defined in masked/number.ts:318

_removeThousandsSeparators

_removeThousandsSeparators(value): string
Parameters
- value: string
Returns string
- Defined in masked/number.ts:104

_separatorsCount

_separatorsCount(to, extendOnSeparators?): number
Parameters
- to: number
- extendOnSeparators: boolean = false
Returns number
- Defined in masked/number.ts:137

_separatorsCountFromSlice

_separatorsCountFromSlice(slice?): number
Parameters
- slice: string = ...
Returns number
- Defined in masked/number.ts:150

_update

_update(opts): void
Sets new options
Parameters
- opts: Partial<Partial<Pick<MaskedNumber, "eager" | "mask" | "parent" | "prepare" | "prepareChar" | "validate" | "commit" | "format" | "parse" | "overwrite" | "skipInvalid" | "autofix" | "min" | "max" | "radix" | "thousandsSeparator" | "mapToRadix" | "scale" | "normalizeZeros" | "padFractionalZeros">>>
Returns void
Overrides Masked._update
- Defined in masked/number.ts:87

_updateRegExps

_updateRegExps(): void
Returns void
- Defined in masked/number.ts:92

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
Overrides Masked.doCommit
- Defined in masked/number.ts:280

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(ch, flags?): [string, ChangeDetails]
Prepares each char before mask processing
Parameters
- ch: string
- flags: AppendFlags<MaskedState> = {}
Returns [string, ChangeDetails]
Overrides Masked.doPrepareChar
- Defined in masked/number.ts:115

doSkipInvalid

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

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
Overrides Masked.extractInput
- Defined in masked/number.ts:154

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
Overrides Masked.nearestInputPos
- Defined in masked/number.ts:249

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
Overrides Masked.remove
- Defined in masked/number.ts:234

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
Overrides Masked.typedValueEquals
- Defined in masked/number.ts:370

updateOptions

updateOptions(opts): void
Sets and applies new options
Parameters
- opts: Partial<Partial<Pick<MaskedNumber, "eager" | "mask" | "parent" | "prepare" | "prepareChar" | "validate" | "commit" | "format" | "parse" | "overwrite" | "skipInvalid" | "autofix" | "min" | "max" | "radix" | "thousandsSeparator" | "mapToRadix" | "scale" | "normalizeZeros" | "padFractionalZeros">>>
Returns void
Overrides Masked.updateOptions
- Defined in masked/number.ts:83

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 MaskedNumber

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns MaskedNumber

Properties

_initialized

Optional _isolated

_mapToRadixRegExp

_numberRegExp

Optional _refreshing

_separatorsProcessed

_thousandsSeparatorRegExp

_value

Optional autofix

Optional commit

Type declaration

Parameters

Returns void

Optional eager

format

Type declaration

Parameters

Returns string

mapToRadix

mask

max

min

normalizeZeros

Optional overwrite

padFractionalZeros

Optional parent

parse

Type declaration

Parameters

Returns number

Optional prepare

Type declaration

Parameters

Returns string | [string, ChangeDetails]

Optional prepareChar

Type declaration

Parameters

Returns string | [string, ChangeDetails]

radix

scale

Optional skipInvalid

thousandsSeparator

Optional validate

Type declaration

Parameters

Returns boolean

Static DEFAULTS

Type declaration

format: ((n) => string)

Parameters

Returns string

mapToRadix: string[]

mask: NumberConstructor

max: number

min: number

normalizeZeros: boolean

padFractionalZeros: boolean

parse: NumberConstructor

radix: string

scale: number

Optional Abstract skipInvalid?: boolean

thousandsSeparator: string

Static EMPTY_VALUES

Static UNMASKED_RADIX

Accessors

allowNegative

Returns boolean

allowPositive

`Optional` _isolated

`Optional` _refreshing

`Optional` autofix

`Optional` commit

`Optional` eager

`Optional` overwrite

`Optional` parent

`Optional` prepare

`Optional` prepareChar

`Optional` skipInvalid

`Optional` validate

`Static` DEFAULTS

`Optional` `Abstract` skipInvalid?: boolean

`Static` EMPTY_VALUES

`Static` UNMASKED_RADIX