@sankhyalabs/core-docs 5.20.0-dev.4 → 5.20.0-dev.6

package/classes/NumberUtils.md

@@ -1,83 +1,74 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / NumberUtils
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / NumberUtils
 
 # Class: NumberUtils
 
 `NumberUtils`: Utilizado para manipulação de numerais.
 
-## Table of contents
+## Constructors
 
-### Constructors
+### new NumberUtils()
 
-- [constructor](NumberUtils.md#constructor)
+> **new NumberUtils**(): [`NumberUtils`](NumberUtils.md)
 
-### Methods
+#### Returns
 
-- [changeFormat](NumberUtils.md#changeformat)
-- [compare](NumberUtils.md#compare)
-- [format](NumberUtils.md#format)
-- [getValueOrDefault](NumberUtils.md#getvalueordefault)
-- [getValueOrZero](NumberUtils.md#getvalueorzero)
-- [keepOnlyDecimalSeparator](NumberUtils.md#keeponlydecimalseparator)
-- [round](NumberUtils.md#round)
-- [safeFormat](NumberUtils.md#safeformat)
-- [stringToNumber](NumberUtils.md#stringtonumber)
+[`NumberUtils`](NumberUtils.md)
 
-## Constructors
+## Methods
 
-### constructor
+### changeFormat()
 
-• **new NumberUtils**()
+> `static` **changeFormat**(`value`): `string`
 
-## Methods
+Troca o formato do numeral(string) de "PT-BR" para "EN-US" e vice-versa.
 
-### changeFormat
+#### Parameters
 
-▸ `Static` **changeFormat**(`value`): `string`
+• **value**: `string`
 
-Troca o formato do numeral(string) de "PT-BR" para "EN-US" e vice-versa.
+Numeral em formato de string a ser convertido.
+
+#### Returns
+
+`string`
+
+- Numeral em formato de string formatado de "PT-BR" para "EN-US" e vice-versa.
 
-**`Example`**
+#### Examples
 
 ```ts
 Informo: "15,55"     | Obtenho: "15.55"
 ```
 
-**`Example`**
-
 ```ts
 Informo: "27.99"     | Obtenho: "27,99"
 ```
 
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `value` | `string` | Numeral em formato de string a ser convertido. |
-
-#### Returns
-
-`string`
-
-- Numeral em formato de string formatado de "PT-BR" para "EN-US" e vice-versa.
-
-#### Defined in
+#### Source
 
 src/utils/NumberUtils.ts:186
 
-___
+***
 
-### compare
+### compare()
 
-▸ `Static` **compare**(`a`, `b`): `number`
+> `static` **compare**(`a`, `b`): `number`
 
 Determina a ordem de umeros.
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `a` | `number` | Primeio número para comparação. |
-| `b` | `number` | Segundo número para comparação. |
+• **a**: `number`
+
+Primeio número para comparação.
+
+• **b**: `number`
+
+Segundo número para comparação.
 
 #### Returns
 
@@ -85,34 +76,35 @@ Determina a ordem de umeros.
 
 - Um numeral negativo se o primeiro argumento é menor que o segundo, zero se os dois são iguais e um numeral positivo quando o primeiro é maior que o segundo.
 
-#### Defined in
+#### Source
 
 src/utils/NumberUtils.ts:267
 
-___
+***
 
-### format
+### format()
 
-▸ `Static` **format**(`value`, `precision`, `prettyPrecision?`, `defaultValue?`): `string`
+> `static` **format**(`value`, `precision`, `prettyPrecision`, `defaultValue`): `string`
 
 Formata o numeral com a precisão informada.
 
-**`Example`**
+#### Parameters
 
-```ts
-Informado: ('10,9845444', 3, 3) | Retorna: '10,985'
-Informado: (undefined, 3, 3) | Retorna: NaN
-Informado: (undefined, 3, 3, '0,00') | Retorna: 0,00
-```
+• **value**: `string`
 
-#### Parameters
+Numeral em formato de string a ser convertido (Importante: formato PT-BR ou já em formato numérico - sem separador de milhares: ######.##).
+
+• **precision**: `number`
+
+Quantidade de casas decimais.
+
+• **prettyPrecision**: `number`= `NaN`
 
-| Name | Type | Default value | Description |
-| :------ | :------ | :------ | :------ |
-| `value` | `string` | `undefined` | Numeral em formato de string a ser convertido (Importante: formato PT-BR ou já em formato numérico - sem separador de milhares: ######.##). |
-| `precision` | `number` | `undefined` | Quantidade de casas decimais. |
-| `prettyPrecision` | `number` | `NaN` | Quantidade de zeros nos decimais. |
-| `defaultValue` | `string` | `undefined` | Valor padrão caso o value não seja um valor numérico válido. |
+Quantidade de zeros nos decimais.
+
+• **defaultValue**: `string`= `undefined`
+
+Valor padrão caso o value não seja um valor numérico válido.
 
 #### Returns
 
@@ -120,66 +112,73 @@ Informado: (undefined, 3, 3, '0,00') | Retorna: 0,00
 
 - Numeral em formato de String formatado em PT-BR.
 
-#### Defined in
+#### Example
+
+```ts
+Informado: ('10,9845444', 3, 3) | Retorna: '10,985'
+Informado: (undefined, 3, 3) | Retorna: NaN
+Informado: (undefined, 3, 3, '0,00') | Retorna: 0,00
+```
+
+#### Source
 
 src/utils/NumberUtils.ts:77
 
-___
+***
 
-### getValueOrDefault
+### getValueOrDefault()
 
-▸ `Static` **getValueOrDefault**(`value`, `defaultValue`): `number`
+> `static` **getValueOrDefault**(`value`, `defaultValue`): `number`
 
 Obtém o valor ou o valor padrão, caso o valor seja inválido(NaN/undefined).
 
-**`Example`**
+#### Parameters
+
+• **value**: `any`
+
+Valor a ser validado.
+
+• **defaultValue**: `number`
+
+Valor padrão a ser retornado caso o value seja inválido.
+
+#### Returns
+
+`number`
+
+- O próprio numeral passado ou zero.
+
+#### Examples
 
 ```ts
 Informo: value: 30, defaultValue: 0     | Obtenho: 30
 ```
 
-**`Example`**
-
 ```ts
 Informo: value: "30", defaultValue: 0   | Obtenho: 30
 ```
 
-**`Example`**
-
 ```ts
 Informo: value: "30abc", defaultValue: 0   | Obtenho: 0
 ```
 
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `value` | `any` | Valor a ser validado. |
-| `defaultValue` | `number` | Valor padrão a ser retornado caso o value seja inválido. |
-
-#### Returns
-
-`number`
-
-- O próprio numeral passado ou zero.
-
-#### Defined in
+#### Source
 
 src/utils/NumberUtils.ts:208
 
-___
+***
 
-### getValueOrZero
+### getValueOrZero()
 
-▸ `Static` **getValueOrZero**(`value`): `number`
+> `static` **getValueOrZero**(`value`): `number`
 
 Obtém o valor ou zero, caso o valor seja inválido(NaN/undefined).
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `value` | `any` | Numeral a ser validado. |
+• **value**: `any`
+
+Numeral a ser validado.
 
 #### Returns
 
@@ -187,30 +186,27 @@ Obtém o valor ou zero, caso o valor seja inválido(NaN/undefined).
 
 - O próprio numeral passado. Caso esse seja inválido retorna zero.
 
-#### Defined in
+#### Source
 
 src/utils/NumberUtils.ts:227
 
-___
+***
 
-### keepOnlyDecimalSeparator
+### keepOnlyDecimalSeparator()
 
-▸ `Static` **keepOnlyDecimalSeparator**(`value`, `formatnumber?`): `string`
+> `static` **keepOnlyDecimalSeparator**(`value`, `formatnumber`): `string`
 
 Retira os separadores de milhar de um numeral em formato de string.
 
-**`Example`**
+#### Parameters
 
-```ts
-Informado: '95.12' | Retorna: '9512'
-```
+• **value**: `string`
 
-#### Parameters
+Numeral em formato de string a ser convertido.
+
+• **formatnumber**: `string`= `'pt-BR'`
 
-| Name | Type | Default value | Description |
-| :------ | :------ | :------ | :------ |
-| `value` | `string` | `undefined` | Numeral em formato de string a ser convertido. |
-| `formatnumber` | `string` | `'pt-BR'` | Formatação de ENTRADA e SAÍDA do utilitário: pt-BR="###.###,##" en-US="###,###.##"; Default: "pt-BR". |
+Formatação de ENTRADA e SAÍDA do utilitário: pt-BR="###.###,##" en-US="###,###.##"; Default: "pt-BR".
 
 #### Returns
 
@@ -218,19 +214,41 @@ Informado: '95.12' | Retorna: '9512'
 
 - Numeral em formato de string formatado apenas com separador decimal.
 
-#### Defined in
+#### Example
+
+```ts
+Informado: '95.12' | Retorna: '9512'
+```
+
+#### Source
 
 src/utils/NumberUtils.ts:158
 
-___
+***
 
-### round
+### round()
 
-▸ `Static` **round**(`value`, `decimals?`): `number`
+> `static` **round**(`value`, `decimals`): `number`
 
 Realiza o arredondamento de casas decimais de um numero.
 
-**`Example`**
+#### Parameters
+
+• **value**: `number`
+
+Numeral a ser arredondado.
+
+• **decimals**: `number`= `2`
+
+Quantidade de casas decimais ussada no arredondamento.
+
+#### Returns
+
+`number`
+
+- O próprio numeral arredondado com a quantidade de casas decimais do argumento decimals.
+
+#### Example
 
 ```ts
 Informo: (100.12)       |   100.12
@@ -249,65 +267,70 @@ Informo: ("100.16", 2)  |   100.16
 Informo: ("100.16", 3)  |   100.16
 ```
 
-#### Parameters
+#### Source
 
-| Name | Type | Default value | Description |
-| :------ | :------ | :------ | :------ |
-| `value` | `number` | `undefined` | Numeral a ser arredondado. |
-| `decimals` | `number` | `2` | Quantidade de casas decimais ussada no arredondamento. |
+src/utils/NumberUtils.ts:255
 
-#### Returns
+***
 
-`number`
+### safeFormat()
 
-- O próprio numeral arredondado com a quantidade de casas decimais do argumento decimals.
+> `static` **safeFormat**(`value`, `precision`, `prettyPrecision`): `string`
 
-#### Defined in
+Formata o numeral com a precisão informada e o valor default 0,00 caso o value não seja um numero valido.
 
-src/utils/NumberUtils.ts:255
+#### Parameters
 
-___
+• **value**: `string`
 
-### safeFormat
+Numeral em formato de string a ser convertido (Importante: formato PT-BR ou já em formato numérico - sem separador de milhares: ######.##).
 
-▸ `Static` **safeFormat**(`value`, `precision`, `prettyPrecision?`): `string`
+• **precision**: `number`
 
-Formata o numeral com a precisão informada e o valor default 0,00 caso o value não seja um numero valido.
+Quantidade de casas decimais.
 
-**`Example`**
+• **prettyPrecision**: `number`= `NaN`
+
+Quantidade de zeros nos decimais.
+
+#### Returns
+
+`string`
+
+- Numeral em formato de String formatado em PT-BR.
+
+#### Example
 
 ```ts
 Informado: ('10,9845444', 3, 3) | Retorna: '10,985'
 Informado: (undefined, 3, 3) | Retorna: 0,00
 ```
 
-#### Parameters
+#### Source
 
-| Name | Type | Default value | Description |
-| :------ | :------ | :------ | :------ |
-| `value` | `string` | `undefined` | Numeral em formato de string a ser convertido (Importante: formato PT-BR ou já em formato numérico - sem separador de milhares: ######.##). |
-| `precision` | `number` | `undefined` | Quantidade de casas decimais. |
-| `prettyPrecision` | `number` | `NaN` | Quantidade de zeros nos decimais. |
+src/utils/NumberUtils.ts:143
 
-#### Returns
+***
 
-`string`
+### stringToNumber()
 
-- Numeral em formato de String formatado em PT-BR.
+> `static` **stringToNumber**(`value`): `number`
 
-#### Defined in
+Converte o dado numérico de string para number.
 
-src/utils/NumberUtils.ts:143
+#### Parameters
 
-___
+• **value**: `string`
 
-### stringToNumber
+Numeral em formato de string a ser convertido (Importante: formato PT-BR ou já em formato numérico: ######.##).
 
-▸ `Static` **stringToNumber**(`value`): `number`
+#### Returns
 
-Converte o dado numérico de string para number.
+`number`
+
+- Numeral passado.
 
-**`Example`**
+#### Example
 
 ```ts
 @"100,12"     |       100.12
@@ -318,18 +341,6 @@ Converte o dado numérico de string para number.
 @"string"     |       NaN
 ```
 
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `value` | `string` | Numeral em formato de string a ser convertido (Importante: formato PT-BR ou já em formato numérico: ######.##). |
-
-#### Returns
-
-`number`
-
-- Numeral passado.
-
-#### Defined in
+#### Source
 
 src/utils/NumberUtils.ts:22