@sankhyalabs/core-docs 0.0.0-bugfix-rc-KB-2229.1 → 0.0.0-bugfix-dev-32613.0

package/classes/KeyboardManager.md

@@ -0,0 +1,233 @@
+[@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)
+
+### Accessors
+
+- [mappedKeys](KeyboardManager.md#mappedkeys)
+
+### 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
+
+## Accessors
+
+### mappedKeys
+
+• `get` **mappedKeys**(): `IGetMappedKeys`[]
+
+Obtém as chaves mapeadas.
+
+#### Returns
+
+`IGetMappedKeys`[]
+
+chaves mapeadas com descrições
+
+#### Defined in
+
+src/utils/KeyboardManager/index.ts:97
+
+## 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:166
+
+___
+
+### 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:113
+
+___
+
+### 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:129
+
+___
+
+### 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:202

package/classes/ObjectUtils.md

@@ -13,6 +13,7 @@
 ### Methods
 
 - [copy](ObjectUtils.md#copy)
+- [equals](ObjectUtils.md#equals)
 - [objectToString](ObjectUtils.md#objecttostring)
 - [removeEmptyValues](ObjectUtils.md#removeemptyvalues)
 - [sortByProperty](ObjectUtils.md#sortbyproperty)
@@ -56,6 +57,31 @@ src/utils/ObjectUtils.ts:13
 
 ___
 
+### equals
+
+▸ `Static` **equals**(`obj1`, `obj2`): `any`
+
+Compara se um objeto é igual a outro objeto.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `obj1` | `any` | Objeto a ser comparado. |
+| `obj2` | `any` | Objeto a ser comparado. |
+
+#### Returns
+
+`any`
+
+- Se o objeto 1 é igual ao objeto 2.
+
+#### Defined in
+
+src/utils/ObjectUtils.ts:84
+
+___
+
 ### objectToString
 
 ▸ `Static` **objectToString**(`data`): `string`

package/classes/SearchUtils.md

@@ -0,0 +1,43 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / SearchUtils
+
+# Class: SearchUtils
+
+`Search`: Utilizado para manipulação de do objeto de pesquisa.
+
+## Table of contents
+
+### Constructors
+
+- [constructor](SearchUtils.md#constructor)
+
+### Methods
+
+- [buildDetails](SearchUtils.md#builddetails)
+
+## Constructors
+
+### constructor
+
+• **new SearchUtils**()
+
+## Methods
+
+### buildDetails
+
+▸ `Static` **buildDetails**(`argument`, `fields`, `item`): `any`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `argument` | `String` |
+| `fields` | `any` |
+| `item` | `any` |
+
+#### Returns
+
+`any`
+
+#### Defined in
+
+src/utils/SearchUtils.ts:8

package/classes/SelectionInfo.md

@@ -45,7 +45,7 @@
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1822
+src/dataunit/DataUnit.ts:1871
 
 ## Properties
 
@@ -55,7 +55,7 @@ src/dataunit/DataUnit.ts:1822
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1816
+src/dataunit/DataUnit.ts:1865
 
 ___
 
@@ -65,7 +65,7 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1818
+src/dataunit/DataUnit.ts:1867
 
 ___
 
@@ -75,7 +75,7 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1819
+src/dataunit/DataUnit.ts:1868
 
 ___
 
@@ -85,7 +85,7 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1817
+src/dataunit/DataUnit.ts:1866
 
 ___
 
@@ -95,7 +95,7 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1820
+src/dataunit/DataUnit.ts:1869
 
 ## Accessors
 
@@ -109,7 +109,7 @@ src/dataunit/DataUnit.ts:1820
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1847
+src/dataunit/DataUnit.ts:1896
 
 ___
 
@@ -123,7 +123,7 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1837
+src/dataunit/DataUnit.ts:1886
 
 ___
 
@@ -137,7 +137,7 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1830
+src/dataunit/DataUnit.ts:1879
 
 ## Methods
 
@@ -151,7 +151,7 @@ src/dataunit/DataUnit.ts:1830
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1854
+src/dataunit/DataUnit.ts:1903
 
 ___
 
@@ -165,4 +165,4 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1858
+src/dataunit/DataUnit.ts:1907

package/classes/SkwHttpProvider.md

@@ -35,7 +35,7 @@
 
 #### Defined in
 
-src/http/SkwHttpProvider.ts:11
+src/http/SkwHttpProvider.ts:8
 
 ___
 
@@ -45,7 +45,7 @@ ___
 
 #### Defined in
 
-src/http/SkwHttpProvider.ts:7
+src/http/SkwHttpProvider.ts:4
 
 ___
 
@@ -55,7 +55,7 @@ ___
 
 #### Defined in
 
-src/http/SkwHttpProvider.ts:9
+src/http/SkwHttpProvider.ts:6
 
 ___
 
@@ -65,7 +65,7 @@ ___
 
 #### Defined in
 
-src/http/SkwHttpProvider.ts:8
+src/http/SkwHttpProvider.ts:5
 
 ___
 
@@ -75,7 +75,7 @@ ___
 
 #### Defined in
 
-src/http/SkwHttpProvider.ts:10
+src/http/SkwHttpProvider.ts:7
 
 ___
 
@@ -85,7 +85,7 @@ ___
 
 #### Defined in
 
-src/http/SkwHttpProvider.ts:5
+src/http/SkwHttpProvider.ts:2
 
 ## Methods
 
@@ -106,4 +106,4 @@ src/http/SkwHttpProvider.ts:5
 
 #### Defined in
 
-src/http/SkwHttpProvider.ts:13
+src/http/SkwHttpProvider.ts:10