@sankhyalabs/core-docs 2.3.4 → 2.3.6

package/classes/MaskFormatter-1.md

@@ -0,0 +1,336 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / MaskFormatter
+
+# Class: MaskFormatter
+
+`MaskFormatter` é usado para formatar strings. Seu comportamento
+é controlado pela 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 maiú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 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.
+
+For 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)
+- [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:83
+
+## Properties
+
+### \_mask
+
+• `Private` **\_mask**: `string` = `''`
+
+#### Defined in
+
+src/utils/MaskFormatter.ts:57
+
+___
+
+### \_maskChars
+
+• `Private` **\_maskChars**: `__class`[]
+
+#### Defined in
+
+src/utils/MaskFormatter.ts:58
+
+___
+
+### 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:64
+
+___
+
+### 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:303
+
+___
+
+### 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:311
+
+___
+
+### 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:271
+
+___
+
+### 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:252
+
+___
+
+### LowerCaseCharacter
+
+▪ `Static` `Private` **LowerCaseCharacter**: typeof `__class`
+
+#### Defined in
+
+src/utils/MaskFormatter.ts:292
+
+___
+
+### 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:282
+
+## Accessors
+
+### mask
+
+• `get` **mask**(): `string`
+
+Getter para mask
+
+#### Returns
+
+`string`
+
+A última máscara informada.
+
+#### Defined in
+
+src/utils/MaskFormatter.ts:79
+
+• `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:69
+
+## 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:93
+
+___
+
+### updateInternalMask
+
+▸ `Private` **updateInternalMask**(): `void`
+
+Preparamos a formatação internamente de acordo com o padrão.
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/utils/MaskFormatter.ts:110

package/classes/NumberUtils.md

@@ -0,0 +1,188 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / NumberUtils
+
+# Class: NumberUtils
+
+`NumberUtils` é uma biblioteca para manipulação de números
+
+`Métodos`:
+
+@stringToNumber: converte um número em formato de string em um valor numérico nativo do javascript
+@format: arredonda um número em formato de string baseado nos parâmetros "presision" e "prettyPrecision";
+
+## Table of contents
+
+### Constructors
+
+- [constructor](NumberUtils.md#constructor)
+
+### Methods
+
+- [changeFormat](NumberUtils.md#changeformat)
+- [format](NumberUtils.md#format)
+- [getValueOrDefault](NumberUtils.md#getvalueordefault)
+- [getValueOrZero](NumberUtils.md#getvalueorzero)
+- [keepOnlyDecimalSeparator](NumberUtils.md#keeponlydecimalseparator)
+- [stringToNumber](NumberUtils.md#stringtonumber)
+
+## Constructors
+
+### constructor
+
+• **new NumberUtils**()
+
+## Methods
+
+### changeFormat
+
+▸ `Static` **changeFormat**(`value`): `string`
+
+@changeFormat: troca o formato do numero string de "PT-BR" para "EN-US" e vice-versa
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `value` | `string` | numero em formato de string a ser convertido |
+
+#### Returns
+
+`string`
+
+numero em formato de string formatado de "PT-BR" para "EN-US" e vice-versa
+
+#### Defined in
+
+src/utils/NumberUtils.ts:171
+
+___
+
+### format
+
+▸ `Static` **format**(`value`, `precision`, `prettyPrecision?`): `string`
+
+@format: converte um numero em formato de string em um numero em formato de string formatado de acordo com os parametros de "precision" e "prettyPrecision"
+
+#### Parameters
+
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `value` | `string` | `undefined` | numero em formato de string a ser convertido (Importante: formato PT-BR ou já em formato numérico - sem separador de milhares: ######.##) |
+| `precision` | `number` | `undefined` | (numero de decimais) |
+| `prettyPrecision` | `number` | `NaN` | (numero de zeros nos decimais) |
+
+#### Returns
+
+`string`
+
+numero em formato de string formatado em PT-BR
+
+#### Defined in
+
+src/utils/NumberUtils.ts:83
+
+___
+
+### getValueOrDefault
+
+▸ `Static` **getValueOrDefault**(`value`, `defaultValue`): `number`
+
+@getValueOrDefault: retorna o valor passado como number, caso NaN retorna o defaultValue
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `value` | `any` | numero a ser validado |
+| `defaultValue` | `number` | numero a ser retornado caso o value seja inválido |
+
+#### Returns
+
+`number`
+
+o proprio numero passado ou zero
+
+#### Defined in
+
+src/utils/NumberUtils.ts:186
+
+___
+
+### getValueOrZero
+
+▸ `Static` **getValueOrZero**(`value`): `number`
+
+@getValueOrZero: valida se o parametro é undefined caso seja retorna zero.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `value` | `any` | numero a ser validado |
+
+#### Returns
+
+`number`
+
+o proprio numero passado ou zero
+
+#### Defined in
+
+src/utils/NumberUtils.ts:205
+
+___
+
+### keepOnlyDecimalSeparator
+
+▸ `Static` **keepOnlyDecimalSeparator**(`value`, `formatnumber?`): `string`
+
+@keepOnlyDecimalSeparator: retira os separadores de milhar de um número em formato de string
+
+#### Parameters
+
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `value` | `string` | `undefined` | numero 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`
+
+numero em formato de string formatado apenas com separador decimal
+
+#### Defined in
+
+src/utils/NumberUtils.ts:147
+
+___
+
+### stringToNumber
+
+▸ `Static` **stringToNumber**(`value`): `number`
+
+@stringToNumber: converte um numero em formato de string em numero
+
+**`Exemples`**
+
+@"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` | numero em formato de string a ser convertido (Importante: formato PT-BR ou já em formato numérico: ######.##) |
+
+#### Returns
+
+`number`
+
+string based number
+
+#### Defined in
+
+src/utils/NumberUtils.ts:33

package/classes/ObjectUtils.md

@@ -0,0 +1,81 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / ObjectUtils
+
+# Class: ObjectUtils
+
+## Table of contents
+
+### Constructors
+
+- [constructor](ObjectUtils.md#constructor)
+
+### Methods
+
+- [copy](ObjectUtils.md#copy)
+- [objectToString](ObjectUtils.md#objecttostring)
+- [stringToObject](ObjectUtils.md#stringtoobject)
+
+## Constructors
+
+### constructor
+
+• **new ObjectUtils**()
+
+## Methods
+
+### copy
+
+▸ `Static` **copy**(`data`): ``null`` \| `Object` \| `Object`[]
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `data` | `Object` \| `Object`[] |
+
+#### Returns
+
+``null`` \| `Object` \| `Object`[]
+
+#### Defined in
+
+src/utils/ObjectUtils.ts:3
+
+___
+
+### objectToString
+
+▸ `Static` **objectToString**(`data`): `string`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `data` | `Object` \| `Object`[] |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+src/utils/ObjectUtils.ts:7
+
+___
+
+### stringToObject
+
+▸ `Static` **stringToObject**(`data`): `Object` \| `Object`[]
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `data` | `string` |
+
+#### Returns
+
+`Object` \| `Object`[]
+
+#### Defined in
+
+src/utils/ObjectUtils.ts:11

package/classes/ReadyUtil.md

@@ -0,0 +1,103 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / ReadyUtil
+
+# Class: ReadyUtil
+
+## Table of contents
+
+### Constructors
+
+- [constructor](ReadyUtil.md#constructor)
+
+### Properties
+
+- [promise](ReadyUtil.md#promise)
+- [resolve](ReadyUtil.md#resolve)
+
+### Methods
+
+- [clean](ReadyUtil.md#clean)
+- [end](ReadyUtil.md#end)
+- [start](ReadyUtil.md#start)
+- [whenReady](ReadyUtil.md#whenready)
+
+## Constructors
+
+### constructor
+
+• **new ReadyUtil**()
+
+## Properties
+
+### promise
+
+• `Private` **promise**: `any`
+
+#### Defined in
+
+src/utils/ReadyUtil.ts:3
+
+___
+
+### resolve
+
+• `Private` **resolve**: `any`
+
+#### Defined in
+
+src/utils/ReadyUtil.ts:2
+
+## Methods
+
+### clean
+
+▸ `Private` **clean**(): `void`
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/utils/ReadyUtil.ts:5
+
+___
+
+### end
+
+▸ **end**(): `void`
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/utils/ReadyUtil.ts:16
+
+___
+
+### start
+
+▸ `Private` **start**(): `void`
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/utils/ReadyUtil.ts:10
+
+___
+
+### whenReady
+
+▸ **whenReady**(): `Promise`<`unknown`\>
+
+#### Returns
+
+`Promise`<`unknown`\>
+
+#### Defined in
+
+src/utils/ReadyUtil.ts:20