Skip to main content

INumberFormatter

Interface

Specific formatter for number

Methods

format

Whatever the input type, formats the data following a certain logic and return that value as a string

Signature

format(value?: number, options?: FormatterFormatOptions) => string

Parameters

NameType
value?number
options?FormatterFormatOptions

Returns

string


formatChange

Optional

Formatter for a price change

Signature

formatChange(currentPrice: number, prevPrice: number, options?: FormatterFormatOptions) => string

Parameters

NameTypeDescription
currentPricenumbercurrent price
prevPricenumberprevious price
options?FormatterFormatOptionsformat options

Returns

string


parse

Optional

Check if the input value satisfies the logic and return either an error or the result of the parsing

Signature

parse(value: string, options?: FormatterParseOptions) => ErrorFormatterParseResult | SuccessFormatterParseResult<number>

Parameters

NameType
valuestring
options?FormatterParseOptions

Returns

ErrorFormatterParseResult | SuccessFormatterParseResult<number>