nginstack

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 FormatOptions

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

Número formatado como string.

Type
string

Members

<inner, constant> LOCALE_CONFIGS :Record.<string, LocaleConfig>

Configurações de locale para formatação.

Type:
  • Record.<string, LocaleConfig>

Methods

<inner> addThousandSeparators(integerText, thousandSeparator)

Adiciona separadores de milhares ao número.

Parameters:
Name Type Description
integerText string

Texto da parte inteira.
thousandSeparator string

Separador de milhares.
Returns:

Número com separadores de milhares.

Type
string

<inner> applyLocaleFormatting(numberText [, locale] [, minimumPrecision])

Formata um número de acordo com as configurações de locale.

Parameters:
Name Type Argument Description
numberText string

Texto do número (usando '.' como decimal).
locale string <optional>

Locale para formatação.
minimumPrecision number <optional>

Precisão mínima de casas decimais.
Returns:

Número formatado.

Type
string

<inner> formatDecimal(value [, options])

Formata um número decimal de acordo com as opções especificadas.

Parameters:
Name Type Argument Description
value number

Valor a ser formatado.
options FormatOptions <optional>

Opções de formatação.
Returns:

Número formatado como string.

Type
string

<inner> formatInteger(value [, options])

Formata um número inteiro removendo casas decimais.

Parameters:
Name Type Argument Description
value number

Valor a ser formatado.
options FormatOptions <optional>

Opções de formatação.
Returns:

Número inteiro formatado como string.

Type
string

<inner> getLocaleConfig( [locale])

Obtém configuração de locale ou retorna padrão.

Parameters:
Name Type Argument Description
locale string <optional>

Locale solicitado.
Throws:

Se locale não for suportado.

Type
Error
Returns:

Configuração do locale.

Type
LocaleConfig

<inner> isFiniteNumber(value)

Verifica se um valor é um número finito.

Parameters:
Name Type Description
value *

Valor a verificar.
Returns:

True se for número finito.

Type
boolean

<inner> padFractionWithZeros(fractionPart, minimumPrecision)

Adiciona zeros à direita para atingir precisão mínima.

Parameters:
Name Type Description
fractionPart string

Parte fracionária.
minimumPrecision number

Precisão mínima requerida.
Returns:

Parte fracionária com zeros adicionados se necessário.

Type
string

<inner> parseNumberParts(numberText)

Separa número em partes inteira e fracionária.

Parameters:
Name Type Description
numberText string

Texto do número (usando '.' como decimal).
Returns:

Partes do número.

Type
NumberParts

<inner> prepareNumberForFormatting(value [, maxPrecision])

Prepara número para formatação aplicando arredondamento.

Parameters:
Name Type Argument Description
value number

Valor original.
maxPrecision number <optional>

Precisão máxima.
Returns:

Texto do número preparado.

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.
maxPrecision number <optional>

Número máximo de 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.