@sankhyalabs/core-docs 0.0.0-feat-dev-KB-14960.1 → 0.0.0-feat-dev-KB-22227.0

package/classes/DateUtils.md

@@ -52,7 +52,7 @@ Realiza correção do horário de verão.
 
 #### Defined in
 
-src/utils/DateUtils.ts:133
+src/utils/DateUtils.ts:136
 
 ___
 
@@ -133,7 +133,7 @@ Converte a data e hora para uma string no formato pt-BR.
 
 #### Defined in
 
-src/utils/DateUtils.ts:50
+src/utils/DateUtils.ts:53
 
 ___
 
@@ -164,7 +164,7 @@ Informo: 2023-03-09 12:42:40     | Obtenho: 2023-03-09T12:42:47-03:00
 
 #### Defined in
 
-src/utils/DateUtils.ts:183
+src/utils/DateUtils.ts:186
 
 ___
 
@@ -189,7 +189,7 @@ Converte as horas de uma data para uma string pt-BR.
 
 #### Defined in
 
-src/utils/DateUtils.ts:38
+src/utils/DateUtils.ts:41
 
 ___
 
@@ -213,7 +213,7 @@ Obtém a data atual.
 
 #### Defined in
 
-src/utils/DateUtils.ts:104
+src/utils/DateUtils.ts:107
 
 ___
 
@@ -249,7 +249,7 @@ Informo:  2     | Obtenho: "02"
 
 #### Defined in
 
-src/utils/DateUtils.ts:152
+src/utils/DateUtils.ts:155
 
 ___
 
@@ -275,7 +275,7 @@ Converte String para Date.
 
 #### Defined in
 
-src/utils/DateUtils.ts:62
+src/utils/DateUtils.ts:65
 
 ___
 
@@ -299,7 +299,7 @@ Timezone da data.
 
 #### Defined in
 
-src/utils/DateUtils.ts:162
+src/utils/DateUtils.ts:165
 
 ___
 
@@ -324,4 +324,4 @@ Retorna se a data é válida.
 
 #### Defined in
 
-src/utils/DateUtils.ts:121
+src/utils/DateUtils.ts:124

package/classes/FieldComparator.md

@@ -47,7 +47,7 @@ ___
 
 ### compareUndefined
 
-▸ `Static` `Private` **compareUndefined**(`isUndefinedA`, `isUndefinedB`): `undefined` \| `number`
+▸ `Static` **compareUndefined**(`isUndefinedA`, `isUndefinedB`): `undefined` \| `number`
 
 #### Parameters
 
@@ -62,7 +62,7 @@ ___
 
 #### Defined in
 
-src/dataunit/sorting/FieldComparator.ts:25
+src/dataunit/sorting/FieldComparator.ts:26
 
 ___
 
@@ -84,4 +84,4 @@ ___
 
 #### Defined in
 
-src/dataunit/sorting/FieldComparator.ts:21
+src/dataunit/sorting/FieldComparator.ts:16

package/classes/JSUtils.md

@@ -13,6 +13,7 @@ Classe com utiliários comuns para funções genéricas em JavaScript.
 ### Methods
 
 - [debounce](JSUtils.md#debounce)
+- [debounceLeading](JSUtils.md#debounceleading)
 - [generateUUID](JSUtils.md#generateuuid)
 - [isBase64](JSUtils.md#isbase64)
 - [isEllipsisActive](JSUtils.md#isellipsisactive)
@@ -50,6 +51,32 @@ src/utils/JSUtils.ts:16
 
 ___
 
+### debounceLeading
+
+▸ `Static` **debounceLeading**(`callback`, `timeout`, `context?`): `VoidFunction`
+
+Método responsável por executar uma função e ignorar as outras posteriores até o tempo especificado.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `callback` | `Function` | Função a ser invocada |
+| `timeout` | `number` | Quantidade de tempo para aguardar antes de invocar novamente |
+| `context?` | `any` | O contexto atual |
+
+#### Returns
+
+`VoidFunction`
+
+A função com o debounce
+
+#### Defined in
+
+src/utils/JSUtils.ts:32
+
+___
+
 ### generateUUID
 
 ▸ `Static` **generateUUID**(): `string`
@@ -64,7 +91,7 @@ Método responsável em gerar um UUID.
 
 #### Defined in
 
-src/utils/JSUtils.ts:66
+src/utils/JSUtils.ts:90
 
 ___
 
@@ -88,7 +115,7 @@ Método que verifica se uma string está encodada com base64.
 
 #### Defined in
 
-src/utils/JSUtils.ts:51
+src/utils/JSUtils.ts:75
 
 ___
 
@@ -112,4 +139,4 @@ Método responsável em validar se um elemento HTML está com o ellipsis ativo.
 
 #### Defined in
 
-src/utils/JSUtils.ts:31
+src/utils/JSUtils.ts:55

package/classes/KeyboardManager.md

@@ -0,0 +1,211 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / KeyboardManager
+
+# Class: KeyboardManager
+
+`KeyboardManager` é reponsável por gerenciar eventos de teclado.
+
+## Table of contents
+
+### Constructors
+
+- [constructor](KeyboardManager.md#constructor)
+
+### Properties
+
+- [\_mappedElements](KeyboardManager.md#_mappedelements)
+- [\_options](KeyboardManager.md#_options)
+
+### Methods
+
+- [bind](KeyboardManager.md#bind)
+- [checkModifiersIsApplied](KeyboardManager.md#checkmodifiersisapplied)
+- [handleListenerEvent](KeyboardManager.md#handlelistenerevent)
+- [keyAppliedWithModifiers](KeyboardManager.md#keyappliedwithmodifiers)
+- [unbind](KeyboardManager.md#unbind)
+- [verifyAndStopPropagation](KeyboardManager.md#verifyandstoppropagation)
+
+## Constructors
+
+### constructor
+
+• **new KeyboardManager**(`options?`)
+
+Construtor para a classe Keyboard.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `options?` | `Partial`<`IKeyboardOptions`\> | opções para o gerenciamento de eventos de teclado. |
+
+#### Defined in
+
+src/utils/KeyboardManager/index.ts:19
+
+## Properties
+
+### \_mappedElements
+
+• `Private` **\_mappedElements**: `IKeyboardMappedKeysElements` = `{}`
+
+#### Defined in
+
+src/utils/KeyboardManager/index.ts:12
+
+___
+
+### \_options
+
+• `Private` **\_options**: `IKeyboardOptions`
+
+#### Defined in
+
+src/utils/KeyboardManager/index.ts:11
+
+## Methods
+
+### bind
+
+▸ **bind**(`keyMap`, `callback`, `options?`): [`KeyboardManager`](KeyboardManager.md)
+
+Associa um evento de teclado com uma função
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `keyMap` | `string` | Chave de mapeamento de teclado. |
+| `callback` | `VoidFunction` | Função a ser executada quando o evento de teclado for disparado. |
+| `options?` | `Partial`<`IKeyboardOptions`\> | Configurações dos eventos de teclado. |
+
+#### Returns
+
+[`KeyboardManager`](KeyboardManager.md)
+
+O objeto `KeyboardManager`
+
+#### Defined in
+
+src/utils/KeyboardManager/index.ts:37
+
+___
+
+### checkModifiersIsApplied
+
+▸ `Private` **checkModifiersIsApplied**(`event`, `modifiedList`): `boolean`
+
+Verifica se todas as teclas modificadoras foram aplicadas ao evento
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `event` | `KeyboardEvent` | O evento de teclado |
+| `modifiedList` | `string`[] | As teclas modificadoras |
+
+#### Returns
+
+`boolean`
+
+Retorna se todas as teclas modificadoras foram aplicadas
+
+#### Defined in
+
+src/utils/KeyboardManager/index.ts:153
+
+___
+
+### handleListenerEvent
+
+▸ `Private` **handleListenerEvent**(`keyMap`, `callback`, `propagate`, `event`): `void`
+
+Executa uma função quando um evento de teclado for disparado
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `keyMap` | `string` | Chave de mapeamento de teclado |
+| `callback` | `VoidFunction` | Função a ser executada |
+| `propagate` | `boolean` | Se o evento de teclado deve ser propagado |
+| `event` | `KeyboardEvent` | O evento de teclado |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/utils/KeyboardManager/index.ts:100
+
+___
+
+### keyAppliedWithModifiers
+
+▸ `Private` **keyAppliedWithModifiers**(`keyMap`, `pressedKeyCode`): `IKeyAppliedResponse`
+
+Verifica se um evento de teclado foi disparado
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `keyMap` | `string` | Chave de mapeamento de teclado |
+| `pressedKeyCode` | `number` | Código do evento de teclado pressionado |
+
+#### Returns
+
+`IKeyAppliedResponse`
+
+Retorna se o evento de teclado foi disparado e as teclas modificadoras aplicadas ao evento
+
+#### Defined in
+
+src/utils/KeyboardManager/index.ts:116
+
+___
+
+### unbind
+
+▸ **unbind**(`keyMap`): [`KeyboardManager`](KeyboardManager.md)
+
+Remove um evento de teclado
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `keyMap` | `string` | Chave de mapeamento de teclado. |
+
+#### Returns
+
+[`KeyboardManager`](KeyboardManager.md)
+
+- O objeto `KeyboardManager`
+
+#### Defined in
+
+src/utils/KeyboardManager/index.ts:73
+
+___
+
+### verifyAndStopPropagation
+
+▸ `Private` **verifyAndStopPropagation**(`event`, `propagate`): `void`
+
+Verifica e impede que o evento de teclado seja propagado
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `event` | `KeyboardEvent` | O evento de teclado |
+| `propagate` | `boolean` | Se o evento de teclado deve ser propagado |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/utils/KeyboardManager/index.ts:189

package/classes/SelectionInfo.md

@@ -45,7 +45,7 @@
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1834
+src/dataunit/DataUnit.ts:1851
 
 ## Properties
 
@@ -55,7 +55,7 @@ src/dataunit/DataUnit.ts:1834
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1828
+src/dataunit/DataUnit.ts:1845
 
 ___
 
@@ -65,7 +65,7 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1830
+src/dataunit/DataUnit.ts:1847
 
 ___
 
@@ -75,7 +75,7 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1831
+src/dataunit/DataUnit.ts:1848
 
 ___
 
@@ -85,7 +85,7 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1829
+src/dataunit/DataUnit.ts:1846
 
 ___
 
@@ -95,7 +95,7 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1832
+src/dataunit/DataUnit.ts:1849
 
 ## Accessors
 
@@ -109,7 +109,7 @@ src/dataunit/DataUnit.ts:1832
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1859
+src/dataunit/DataUnit.ts:1876
 
 ___
 
@@ -123,7 +123,7 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1849
+src/dataunit/DataUnit.ts:1866
 
 ___
 
@@ -137,7 +137,7 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1842
+src/dataunit/DataUnit.ts:1859
 
 ## Methods
 
@@ -151,7 +151,7 @@ src/dataunit/DataUnit.ts:1842
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1866
+src/dataunit/DataUnit.ts:1883
 
 ___
 
@@ -165,4 +165,4 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1870
+src/dataunit/DataUnit.ts:1887

package/classes/StringUtils.md

@@ -17,8 +17,11 @@
 - [formatBytes](StringUtils.md#formatbytes)
 - [generateUUID](StringUtils.md#generateuuid)
 - [getBooleanValue](StringUtils.md#getbooleanvalue)
+- [getOppositeCase](StringUtils.md#getoppositecase)
 - [hashCode](StringUtils.md#hashcode)
+- [isCaseable](StringUtils.md#iscaseable)
 - [isEmpty](StringUtils.md#isempty)
+- [isLowerCase](StringUtils.md#islowercase)
 - [padEnd](StringUtils.md#padend)
 - [padStart](StringUtils.md#padstart)
 - [prettyPrecision](StringUtils.md#prettyprecision)
@@ -61,7 +64,7 @@ Determina a ordem de strings.
 
 #### Defined in
 
-src/utils/StringUtils.ts:223
+src/utils/StringUtils.ts:234
 
 ___
 
@@ -89,7 +92,7 @@ entrada: "&lt;Teste&gt;" // retorno: "<Teste>"
 
 #### Defined in
 
-src/utils/StringUtils.ts:55
+src/utils/StringUtils.ts:60
 
 ___
 
@@ -97,7 +100,7 @@ ___
 
 ▸ `Static` **formatBytes**(`bytes`): `string`
 
-Utilitário para formatar bytes em string legível, convertendo para 
+Utilitário para formatar bytes em string legível, convertendo para
 múltiplos maiores caso necessário.
 
 #### Parameters
@@ -114,7 +117,7 @@ string formatada de acordo com a unidade.
 
 #### Defined in
 
-src/utils/StringUtils.ts:308
+src/utils/StringUtils.ts:319
 
 ___
 
@@ -132,7 +135,7 @@ id único randômico.
 
 #### Defined in
 
-src/utils/StringUtils.ts:354
+src/utils/StringUtils.ts:365
 
 ___
 
@@ -164,7 +167,31 @@ Informado: 'false' | Retorna: false
 
 #### Defined in
 
-src/utils/StringUtils.ts:153
+src/utils/StringUtils.ts:164
+
+___
+
+### getOppositeCase
+
+▸ `Static` **getOppositeCase**(`original`): `string`
+
+Inverte uma string de minúsculas para maiúsculas e vice-versa
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `original` | `string` | A string a ser invertida |
+
+#### Returns
+
+`string`
+
+A string invertida
+
+#### Defined in
+
+src/utils/StringUtils.ts:400
 
 ___
 
@@ -194,7 +221,31 @@ Informado: '123456' | Retorna: 1450575459
 
 #### Defined in
 
-src/utils/StringUtils.ts:132
+src/utils/StringUtils.ts:143
+
+___
+
+### isCaseable
+
+▸ `Static` **isCaseable**(`original`): `boolean`
+
+Checa se uma string pode ser convertida para letras maiúsculas ou minúsculas
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `original` | `string` | A string a ser verificada |
+
+#### Returns
+
+`boolean`
+
+Se a string pode ser convertida
+
+#### Defined in
+
+src/utils/StringUtils.ts:375
 
 ___
 
@@ -223,6 +274,30 @@ src/utils/StringUtils.ts:16
 
 ___
 
+### isLowerCase
+
+▸ `Static` **isLowerCase**(`original`): `boolean`
+
+Checa se uma string é minúscula
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `original` | `string` | A string a ser verificada |
+
+#### Returns
+
+`boolean`
+
+Se a string é minúscula
+
+#### Defined in
+
+src/utils/StringUtils.ts:388
+
+___
+
 ### padEnd
 
 ▸ `Static` **padEnd**(`str`, `len`, `pad?`): `string`
@@ -258,7 +333,7 @@ Ou retorna o texto com os caracteres adicionados na direita.
 
 #### Defined in
 
-src/utils/StringUtils.ts:207
+src/utils/StringUtils.ts:218
 
 ___
 
@@ -297,7 +372,7 @@ Ou retorna o texto com os caracteres adicionados na esquerda.
 
 #### Defined in
 
-src/utils/StringUtils.ts:182
+src/utils/StringUtils.ts:193
 
 ___
 
@@ -322,7 +397,7 @@ simplificação do strNumber, sem os zeros à direita depois do ponto.
 
 #### Defined in
 
-src/utils/StringUtils.ts:333
+src/utils/StringUtils.ts:344
 
 ___
 
@@ -352,7 +427,7 @@ entrada: "á@Êç#Ò", true // retorno: "aEcO"
 
 #### Defined in
 
-src/utils/StringUtils.ts:105
+src/utils/StringUtils.ts:113
 
 ___
 
@@ -376,7 +451,7 @@ Remove acentos de vogais, substitui Ç por c e retorna a string em caixa alta ma
 
 #### Defined in
 
-src/utils/StringUtils.ts:121
+src/utils/StringUtils.ts:132
 
 ___
 
@@ -404,7 +479,7 @@ entrada: "áêçò" // retorno: "aeco"
 
 #### Defined in
 
-src/utils/StringUtils.ts:85
+src/utils/StringUtils.ts:90
 
 ___
 
@@ -456,7 +531,7 @@ String sem espaços em branco.
 
 #### Defined in
 
-src/utils/StringUtils.ts:298
+src/utils/StringUtils.ts:309
 
 ___
 
@@ -487,7 +562,7 @@ String convertida em camelCase.
 
 #### Defined in
 
-src/utils/StringUtils.ts:249
+src/utils/StringUtils.ts:260
 
 ___
 
@@ -511,7 +586,7 @@ String convertida em KebabCase.
 
 #### Defined in
 
-src/utils/StringUtils.ts:289
+src/utils/StringUtils.ts:300
 
 ___
 
@@ -535,7 +610,7 @@ String convertida em PascalCase.
 
 #### Defined in
 
-src/utils/StringUtils.ts:264
+src/utils/StringUtils.ts:275
 
 ___
 
@@ -559,4 +634,4 @@ String convertida em snake_case.
 
 #### Defined in
 
-src/utils/StringUtils.ts:276
+src/utils/StringUtils.ts:287