@sankhyalabs/core-docs 0.0.0-bugfix-dev-KB-6165.0

package/classes/JSUtils.md

@@ -0,0 +1,115 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / JSUtils
+
+# Class: JSUtils
+
+Classe com utiliários comuns para funções genéricas em JavaScript.
+
+## Table of contents
+
+### Constructors
+
+- [constructor](JSUtils.md#constructor)
+
+### Methods
+
+- [debounce](JSUtils.md#debounce)
+- [generateUUID](JSUtils.md#generateuuid)
+- [isBase64](JSUtils.md#isbase64)
+- [isEllipsisActive](JSUtils.md#isellipsisactive)
+
+## Constructors
+
+### constructor
+
+• **new JSUtils**()
+
+## Methods
+
+### debounce
+
+▸ `Static` **debounce**(`callback`, `timeout?`): `any`
+
+Método responsável em criar um timer para processar uma determinada função.
+
+#### Parameters
+
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `callback` | `any` | `undefined` | Função de callback para processar após o timer. |
+| `timeout` | `number` | `300` | Valor dos milissegundos desejados para processar a função (o padrão é 300). |
+
+#### Returns
+
+`any`
+
+- Retorna um método com controle de timer para processar a função de callback.
+
+#### Defined in
+
+src/utils/JSUtils.ts:16
+
+___
+
+### generateUUID
+
+▸ `Static` **generateUUID**(): `string`
+
+Método responsável em gerar um UUID.
+
+#### Returns
+
+`string`
+
+- Retorna um UUID.
+
+#### Defined in
+
+src/utils/JSUtils.ts:66
+
+___
+
+### isBase64
+
+▸ `Static` **isBase64**(`str`): `boolean`
+
+Método que verifica se uma string está encodada com base64.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `str` | `string` | String que será verificada. |
+
+#### Returns
+
+`boolean`
+
+- Retorna um valor booleando informando se a string está encodada com base64.
+
+#### Defined in
+
+src/utils/JSUtils.ts:51
+
+___
+
+### isEllipsisActive
+
+▸ `Static` **isEllipsisActive**(`element`): `boolean`
+
+Método responsável em validar se um elemento HTML está com o ellipsis ativo.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `element` | `any` | Elemento HTML que será verificado. |
+
+#### Returns
+
+`boolean`
+
+- Retorna um valor booleando informando se o elemento está com o ellipsis ativo.
+
+#### Defined in
+
+src/utils/JSUtils.ts:31

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