Caplin Trader 5.1.0 - Class: module:br-parsing/ThousandsParser

Class: module:br-parsing/ThousandsParser

module:br-parsing/ThousandsParser()

Parses an amount and strips any thousands separators.

ThousandsParser is typically used with Presenter, but can be invoked programmatically as in the following example which evaluates to "8987551787.0":

ThousandsParser.parse("8,987,551,787.0", {})

The number grouping separator will change per locale. The english separator defaults to "," as in the example above, see the i18n property br.i18n.number.grouping.separator in other locales for their separators.

See module:br-formatting/ThousandsFormatter for the complementary formatter.

Constructor

new module:br-parsing/ThousandsParser()

Implements:

module:br-parsing/Parser

Methods

isSingleUseParser()

Allows parsers that should only run a single time, and that should not repeatedly re-parse their own output.

This method is optional. Parsers that don't implement it are not considered to be single-use parsers by default.

Implements:

module:br-parsing/Parser#isSingleUseParser

parse(vValue, mAttributes)

Parses an amount, strips any thousands separators and changes the local radix (decimal point) char into a ".".

Attribute Options:

Option	Description
separator	the token representing thousands (defaults to a comma in en_GB locale)

Parameters:

Name	Type	Description
`vValue`	Variant	the amount.
`mAttributes`	Map	the map of attributes.

Implements:

module:br-parsing/Parser#parse

Returns:

the amount, with any number grouping separators removed