Module: @nginstack/engine/lib/number/formatNumber

(require("@nginstack/engine/lib/number/formatNumber"))(value, options)

Converte um número para o formato desejado.

Parameters:
Name Type Description
value number

Valor a ser formatado.
options module:@nginstack/engine/lib/number/formatNumber~FormatOptions

Opções para formatação.
See:
  • module:@nginstack/engine/lib/number/NumberFormat~NumberFormat
Returns:

Número formatado como string.

Type
string

Type Definitions

FormatOptions

Type:
  • Object
Properties:
Name Type Argument Description
format number

Formato a ser utilizado. Deve ser um dos valores exportados por NumberFormat.
locale 'pt-br'| 'en-us' <optional>

Localidade a ser utilizada. Por padrão é considerado 'pt-br', mas também é aceito 'en-us'.
minPrecision number <optional>

Número mínimo de casas decimais. Ignorado no formato FILE_SIZE.
maxPrecision number <optional>

Número máximo de casas decimais. Ignorado no formato FILE_SIZE, que utiliza sempre no máximo 2 casas decimais.

LocaleConfig

Type:
  • Object
Properties:
Name Type Description
thousandSeparator string

Separador de milhares.
decimalSeparator string

Separador decimal.

NumberParts

Type:
  • Object
Properties:
Name Type Description
integerPart string

Parte inteira do número.
fractionPart string

Parte fracionária do número.
isNegative boolean

Se o número é negativo.