@sankhyalabs/core-docs 0.0.0-hotfix-ga-KB-4098.0

package/classes/MaskFormatter-1.md

@@ -0,0 +1,347 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / MaskFormatter
+
+# Class: MaskFormatter
+
+`MaskFormatter` é usado para formatar strings. Seu comportamento
+é controlado pelo formato do atributo `mask` que especifica quais
+caracteres são válidos e onde devem estar posicionados, intercalando-os
+com eventuais caracteres literais expressados no padrão informado.
+Sua implementação é inspirada pela implementação em Java do [MaskFormatter](https://docs.oracle.com/javase/7/docs/api/javax/swing/text/MaskFormatter.html).
+
+Para o padrão da máscara podem ser usados os seguintes caracteres especiais:
+
+| Caractere | Comportamento                                                                                               |
+|:---------:|-------------------------------------------------------------------------------------------------------------|
+| #         | Qualquer número                                                                                             |
+| '         | "Escapa" o caractere que vem na sequência. Útil quando desejamos converter um caractere especial em literal.|
+| U         | Qualquer letra. Transforma letras minúsculas em maiúsculas.                                                 |
+| L         | Qualquer letra. Transforma letras maiúsculas em minúsculas.                                                 |
+| A         | Qualquer letra ou número.                                                                                   |
+| ?         | Qualquer letra. Preserva maiúsculas e minúsculas.                                                           |
+| *         | Qualquer caractere.                                                                                         |
+
+Os demais caracteres presentes no padrão serão tratados como literais, isto é,
+serão apenas inseridos naquela posição.
+
+Quando o valor a ser formatado é menor que a máscara, um 'placeHolder'
+será inserido em cada posição ausente, completando a formatação.
+Por padrão será usado um espaço em branco como 'placeHolder', mas
+esse valor pode ser alterado.
+
+Por exemplo:
+'''
+   const formatter: MaskFormatter = new MaskFormatter("###-####");
+   formatter.placeholder = '_';
+   console.log(formatter.format("123"));
+'''
+resultaria na string '123-____'.
+
+##Veja mais alguns exemplos:
+|Padrão          |Máscara           |Entrada       |Saída             |
+|----------------|------------------|--------------|------------------|
+|Telefone        |(##) ####-####    |3432192515    |(34) 3219-2515    |
+|CPF             |###.###.###-##    |12345678901   |123.456.789-01    |
+|CNPJ            |##.###.###/####-##|12345678901234|12.345.678/9012-34|
+|CEP             |##.###-###        |12345678      |12.345-678        |
+|PLACA (veículo) |UUU-####          |abc1234       |ABC-1234          |
+|Cor RGB         |'#AAAAAA          |00000F0       |#0000F0           |
+
+## Table of contents
+
+### Constructors
+
+- [constructor](MaskFormatter-1.md#constructor)
+
+### Properties
+
+- [\_mask](MaskFormatter-1.md#_mask)
+- [\_maskChars](MaskFormatter-1.md#_maskchars)
+- [placeholder](MaskFormatter-1.md#placeholder)
+- [ALPHA\_NUMERIC\_KEY](MaskFormatter-1.md#alpha_numeric_key)
+- [ANYTHING\_KEY](MaskFormatter-1.md#anything_key)
+- [AlphaNumericCharacter](MaskFormatter-1.md#alphanumericcharacter)
+- [CHARACTER\_KEY](MaskFormatter-1.md#character_key)
+- [CharCharacter](MaskFormatter-1.md#charcharacter)
+- [DEFAULT\_MASKS](MaskFormatter-1.md#default_masks)
+- [DIGIT\_KEY](MaskFormatter-1.md#digit_key)
+- [DigitMaskCharacter](MaskFormatter-1.md#digitmaskcharacter)
+- [LITERAL\_KEY](MaskFormatter-1.md#literal_key)
+- [LOWERCASE\_KEY](MaskFormatter-1.md#lowercase_key)
+- [LiteralCharacter](MaskFormatter-1.md#literalcharacter)
+- [LowerCaseCharacter](MaskFormatter-1.md#lowercasecharacter)
+- [UPPERCASE\_KEY](MaskFormatter-1.md#uppercase_key)
+- [UpperCaseCharacter](MaskFormatter-1.md#uppercasecharacter)
+
+### Accessors
+
+- [mask](MaskFormatter-1.md#mask)
+
+### Methods
+
+- [format](MaskFormatter-1.md#format)
+- [updateInternalMask](MaskFormatter-1.md#updateinternalmask)
+
+## Constructors
+
+### constructor
+
+• **new MaskFormatter**(`mask`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `mask` | `string` |
+
+#### Defined in
+
+src/utils/MaskFormatter.ts:91
+
+## Properties
+
+### \_mask
+
+• `Private` **\_mask**: `string` = `''`
+
+#### Defined in
+
+src/utils/MaskFormatter.ts:65
+
+___
+
+### \_maskChars
+
+• `Private` **\_maskChars**: `__class`[]
+
+#### Defined in
+
+src/utils/MaskFormatter.ts:66
+
+___
+
+### placeholder
+
+• **placeholder**: `string` = `' '`
+
+Determina qual caractere será usado dos caracteres não presentes no valor,
+ou seja, aqueles que o usuário ainda não informou. Por padrão usamos um espaço.
+
+#### Defined in
+
+src/utils/MaskFormatter.ts:72
+
+___
+
+### ALPHA\_NUMERIC\_KEY
+
+▪ `Static` `Private` **ALPHA\_NUMERIC\_KEY**: `string` = `"A"`
+
+#### Defined in
+
+src/utils/MaskFormatter.ts:53
+
+___
+
+### ANYTHING\_KEY
+
+▪ `Static` `Private` **ANYTHING\_KEY**: `string` = `"*"`
+
+#### Defined in
+
+src/utils/MaskFormatter.ts:55
+
+___
+
+### AlphaNumericCharacter
+
+▪ `Static` `Private` **AlphaNumericCharacter**: typeof `__class`
+
+#### Defined in
+
+src/utils/MaskFormatter.ts:375
+
+___
+
+### CHARACTER\_KEY
+
+▪ `Static` `Private` **CHARACTER\_KEY**: `string` = `"?"`
+
+#### Defined in
+
+src/utils/MaskFormatter.ts:54
+
+___
+
+### CharCharacter
+
+▪ `Static` `Private` **CharCharacter**: typeof `__class`
+
+#### Defined in
+
+src/utils/MaskFormatter.ts:389
+
+___
+
+### DEFAULT\_MASKS
+
+▪ `Static` **DEFAULT\_MASKS**: `any`
+
+#### Defined in
+
+src/utils/MaskFormatter.ts:57
+
+___
+
+### DIGIT\_KEY
+
+▪ `Static` `Private` **DIGIT\_KEY**: `string` = `"#"`
+
+#### Defined in
+
+src/utils/MaskFormatter.ts:49
+
+___
+
+### DigitMaskCharacter
+
+▪ `Static` `Private` **DigitMaskCharacter**: typeof `__class`
+
+#### Defined in
+
+src/utils/MaskFormatter.ts:300
+
+___
+
+### LITERAL\_KEY
+
+▪ `Static` `Private` **LITERAL\_KEY**: `string` = `"'"`
+
+#### Defined in
+
+src/utils/MaskFormatter.ts:50
+
+___
+
+### LOWERCASE\_KEY
+
+▪ `Static` `Private` **LOWERCASE\_KEY**: `string` = `"L"`
+
+#### Defined in
+
+src/utils/MaskFormatter.ts:52
+
+___
+
+### LiteralCharacter
+
+▪ `Static` `Private` **LiteralCharacter**: typeof `__class`
+
+#### Defined in
+
+src/utils/MaskFormatter.ts:281
+
+___
+
+### LowerCaseCharacter
+
+▪ `Static` `Private` **LowerCaseCharacter**: typeof `__class`
+
+#### Defined in
+
+src/utils/MaskFormatter.ts:352
+
+___
+
+### UPPERCASE\_KEY
+
+▪ `Static` `Private` **UPPERCASE\_KEY**: `string` = `"U"`
+
+#### Defined in
+
+src/utils/MaskFormatter.ts:51
+
+___
+
+### UpperCaseCharacter
+
+▪ `Static` `Private` **UpperCaseCharacter**: typeof `__class`
+
+#### Defined in
+
+src/utils/MaskFormatter.ts:329
+
+## Accessors
+
+### mask
+
+• `get` **mask**(): `string`
+
+Getter para mask.
+
+#### Returns
+
+`string`
+
+A última máscara informada.
+
+#### Defined in
+
+src/utils/MaskFormatter.ts:87
+
+• `set` **mask**(`mask`): `void`
+
+Setter para mask. Trata-se do padrão que se espera ao formatar o texto.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `mask` | `string` |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/utils/MaskFormatter.ts:77
+
+## Methods
+
+### format
+
+▸ **format**(`value`): `string`
+
+Formata a string passada baseada na máscara definda pelo atributo mask.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `value` | `string` | Valor a ser formatado. |
+
+#### Returns
+
+`string`
+
+O valor processado de acordo com o padrão.
+
+#### Defined in
+
+src/utils/MaskFormatter.ts:101
+
+___
+
+### updateInternalMask
+
+▸ `Private` **updateInternalMask**(): `void`
+
+Prepara a formatação internamente de acordo com o padrão.
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/utils/MaskFormatter.ts:118

package/classes/NumberUtils.md

@@ -0,0 +1,335 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / NumberUtils
+
+# Class: NumberUtils
+
+`NumberUtils`: Utilizado para manipulação de numerais.
+
+## Table of contents
+
+### Constructors
+
+- [constructor](NumberUtils.md#constructor)
+
+### Methods
+
+- [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)
+
+## Constructors
+
+### constructor
+
+• **new NumberUtils**()
+
+## Methods
+
+### changeFormat
+
+▸ `Static` **changeFormat**(`value`): `string`
+
+Troca o formato do numeral(string) de "PT-BR" para "EN-US" e vice-versa.
+
+**`Example`**
+
+```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
+
+src/utils/NumberUtils.ts:186
+
+___
+
+### compare
+
+▸ `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. |
+
+#### Returns
+
+`number`
+
+- 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
+
+src/utils/NumberUtils.ts:267
+
+___
+
+### format
+
+▸ `Static` **format**(`value`, `precision`, `prettyPrecision?`, `defaultValue?`): `string`
+
+Formata o numeral com a precisão informada.
+
+**`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
+```
+
+#### Parameters
+
+| 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. |
+
+#### Returns
+
+`string`
+
+- Numeral em formato de String formatado em PT-BR.
+
+#### Defined in
+
+src/utils/NumberUtils.ts:77
+
+___
+
+### getValueOrDefault
+
+▸ `Static` **getValueOrDefault**(`value`, `defaultValue`): `number`
+
+Obtém o valor ou o valor padrão, caso o valor seja inválido(NaN/undefined).
+
+**`Example`**
+
+```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
+
+src/utils/NumberUtils.ts:208
+
+___
+
+### getValueOrZero
+
+▸ `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. |
+
+#### Returns
+
+`number`
+
+- O próprio numeral passado. Caso esse seja inválido retorna zero.
+
+#### Defined in
+
+src/utils/NumberUtils.ts:227
+
+___
+
+### keepOnlyDecimalSeparator
+
+▸ `Static` **keepOnlyDecimalSeparator**(`value`, `formatnumber?`): `string`
+
+Retira os separadores de milhar de um numeral em formato de string.
+
+**`Example`**
+
+```ts
+Informado: '95.12' | Retorna: '9512'
+```
+
+#### Parameters
+
+| 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". |
+
+#### Returns
+
+`string`
+
+- Numeral em formato de string formatado apenas com separador decimal.
+
+#### Defined in
+
+src/utils/NumberUtils.ts:158
+
+___
+
+### round
+
+▸ `Static` **round**(`value`, `decimals?`): `number`
+
+Realiza o arredondamento de casas decimais de um numero.
+
+**`Example`**
+
+```ts
+Informo: (100.12)       |   100.12
+Informo: (100,12)       |   NaN
+
+Informo: ("100.12", 1)  |   100.1
+Informo: ("100.12", 2)  |   100.12
+Informo: ("100.12", 3)  |   100.12
+
+Informo: ("100.15", 1)  |   100.2
+Informo: ("100.15", 2)  |   100.15
+Informo: ("100.15", 3)  |   100.15
+
+Informo: ("100.16", 1)  |   100.2
+Informo: ("100.16", 2)  |   100.16
+Informo: ("100.16", 3)  |   100.16
+```
+
+#### Parameters
+
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `value` | `number` | `undefined` | 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.
+
+#### Defined in
+
+src/utils/NumberUtils.ts:255
+
+___
+
+### safeFormat
+
+▸ `Static` **safeFormat**(`value`, `precision`, `prettyPrecision?`): `string`
+
+Formata o numeral com a precisão informada e o valor default 0,00 caso o value não seja um numero valido.
+
+**`Example`**
+
+```ts
+Informado: ('10,9845444', 3, 3) | Retorna: '10,985'
+Informado: (undefined, 3, 3) | Retorna: 0,00
+```
+
+#### Parameters
+
+| 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. |
+
+#### Returns
+
+`string`
+
+- Numeral em formato de String formatado em PT-BR.
+
+#### Defined in
+
+src/utils/NumberUtils.ts:143
+
+___
+
+### stringToNumber
+
+▸ `Static` **stringToNumber**(`value`): `number`
+
+Converte o dado numérico de string para number.
+
+**`Example`**
+
+```ts
+@"100,12"     |       100.12
+@"100.12"     |       100.12
+@"-100,12"    |       -100.12
+@"R$100,12"   |       100.12
+@"-R$100,12"  |       -100.12
+@"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
+
+src/utils/NumberUtils.ts:22