@sankhyalabs/core-docs 5.15.5 → 5.16.0

package/classes/JSUtils.md

@@ -1,44 +1,40 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / JSUtils
+[**@sankhyalabs/core**](../README.md) • **Docs**
 
-# Class: JSUtils
-
-Classe com utiliários comuns para funções genéricas em JavaScript.
+***
 
-## Table of contents
+[@sankhyalabs/core](../globals.md) / JSUtils
 
-### Constructors
+# Class: JSUtils
 
-- [constructor](JSUtils.md#constructor)
+Classe com utiliários comuns para funções genéricas em JavaScript.
 
-### Methods
+## Constructors
 
-- [debounce](JSUtils.md#debounce)
-- [debounceLeading](JSUtils.md#debounceleading)
-- [generateUUID](JSUtils.md#generateuuid)
-- [isBase64](JSUtils.md#isbase64)
-- [isEllipsisActive](JSUtils.md#isellipsisactive)
-- [isHiddenElement](JSUtils.md#ishiddenelement)
+### new JSUtils()
 
-## Constructors
+> **new JSUtils**(): [`JSUtils`](JSUtils.md)
 
-### constructor
+#### Returns
 
-• **new JSUtils**()
+[`JSUtils`](JSUtils.md)
 
 ## Methods
 
-### debounce
+### debounce()
 
-▸ `Static` **debounce**(`callback`, `timeout?`): `any`
+> `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). |
+• **callback**: `any`
+
+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
 
@@ -46,25 +42,31 @@ Método responsável em criar um timer para processar uma determinada função.
 
 - Retorna um método com controle de timer para processar a função de callback.
 
-#### Defined in
+#### Source
 
 src/utils/JSUtils.ts:21
 
-___
+***
 
-### debounceLeading
+### debounceLeading()
 
-▸ `Static` **debounceLeading**(`callback`, `timeout?`, `context?`): `VoidFunction`
+> `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 | Default value | Description |
-| :------ | :------ | :------ | :------ |
-| `callback` | `Function` | `undefined` | Função a ser invocada |
-| `timeout` | `number` | `300` | Quantidade de tempo para aguardar antes de invocar novamente |
-| `context?` | `any` | `undefined` | O contexto atual |
+• **callback**: `Function`
+
+Função a ser invocada
+
+• **timeout**: `number`= `300`
+
+Quantidade de tempo para aguardar antes de invocar novamente
+
+• **context?**: `any`
+
+O contexto atual
 
 #### Returns
 
@@ -72,15 +74,15 @@ Método responsável por executar uma função e ignorar as outras posteriores a
 
 A função com o debounce
 
-#### Defined in
+#### Source
 
 src/utils/JSUtils.ts:37
 
-___
+***
 
-### generateUUID
+### generateUUID()
 
-▸ `Static` **generateUUID**(): `string`
+> `static` **generateUUID**(): `string`
 
 Método responsável em gerar um UUID.
 
@@ -90,23 +92,23 @@ Método responsável em gerar um UUID.
 
 - Retorna um UUID.
 
-#### Defined in
+#### Source
 
 src/utils/JSUtils.ts:95
 
-___
+***
 
-### isBase64
+### isBase64()
 
-▸ `Static` **isBase64**(`str`): `boolean`
+> `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. |
+• **str**: `string`
+
+String que será verificada.
 
 #### Returns
 
@@ -114,23 +116,23 @@ Método que verifica se uma string está encodada com base64.
 
 - Retorna um valor booleando informando se a string está encodada com base64.
 
-#### Defined in
+#### Source
 
 src/utils/JSUtils.ts:80
 
-___
+***
 
-### isEllipsisActive
+### isEllipsisActive()
 
-▸ `Static` **isEllipsisActive**(`element`): `boolean`
+> `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. |
+• **element**: `any`
+
+Elemento HTML que será verificado.
 
 #### Returns
 
@@ -138,26 +140,48 @@ Método responsável em validar se um elemento HTML está com o ellipsis ativo.
 
 - Retorna um valor booleando informando se o elemento está com o ellipsis ativo.
 
-#### Defined in
+#### Source
 
 src/utils/JSUtils.ts:60
 
-___
+***
 
-### isHiddenElement
+### isHiddenElement()
 
-▸ `Static` **isHiddenElement**(`element`): `boolean`
+> `static` **isHiddenElement**(`element`): `boolean`
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `element` | `HTMLElement` |
+• **element**: `HTMLElement`
 
 #### Returns
 
 `boolean`
 
-#### Defined in
+#### Source
 
 src/utils/JSUtils.ts:8
+
+***
+
+### replaceHtmlEntities()
+
+> `static` **replaceHtmlEntities**(`source`): `string`
+
+Substitui caracteres para suas entidades HTML.
+
+#### Parameters
+
+• **source**: `string`
+
+String a ter os caracteres substituidos.
+
+#### Returns
+
+`string`
+
+- Retorna um UUID.
+
+#### Source
+
+src/utils/JSUtils.ts:105

package/classes/KeyboardManager.md

@@ -1,48 +1,32 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / KeyboardManager
+[**@sankhyalabs/core**](../README.md) • **Docs**
 
-# Class: KeyboardManager
-
-`KeyboardManager` é reponsável por gerenciar eventos de teclado.
-
-## Table of contents
-
-### Constructors
+***
 
-- [constructor](KeyboardManager.md#constructor)
+[@sankhyalabs/core](../globals.md) / KeyboardManager
 
-### Properties
-
-- [\_mappedElements](KeyboardManager.md#_mappedelements)
-- [\_options](KeyboardManager.md#_options)
-
-### Accessors
-
-- [mappedKeys](KeyboardManager.md#mappedkeys)
-
-### Methods
+# Class: KeyboardManager
 
-- [bind](KeyboardManager.md#bind)
-- [checkModifiersIsApplied](KeyboardManager.md#checkmodifiersisapplied)
-- [handleListenerEvent](KeyboardManager.md#handlelistenerevent)
-- [keyAppliedWithModifiers](KeyboardManager.md#keyappliedwithmodifiers)
-- [unbind](KeyboardManager.md#unbind)
-- [verifyAndStopPropagation](KeyboardManager.md#verifyandstoppropagation)
+`KeyboardManager` é reponsável por gerenciar eventos de teclado.
 
 ## Constructors
 
-### constructor
+### new KeyboardManager()
 
-• **new KeyboardManager**(`options?`)
+> **new KeyboardManager**(`options`?): [`KeyboardManager`](KeyboardManager.md)
 
 Construtor para a classe Keyboard.
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `options?` | `Partial`<`IKeyboardOptions`\> | opções para o gerenciamento de eventos de teclado. |
+• **options?**: `Partial`\<`IKeyboardOptions`\>
+
+opções para o gerenciamento de eventos de teclado.
 
-#### Defined in
+#### Returns
+
+[`KeyboardManager`](KeyboardManager.md)
+
+#### Source
 
 src/utils/KeyboardManager/index.ts:19
 
@@ -50,19 +34,19 @@ src/utils/KeyboardManager/index.ts:19
 
 ### \_mappedElements
 
-• `Private` **\_mappedElements**: `IKeyboardMappedKeysElements` = `{}`
+> `private` **\_mappedElements**: `IKeyboardMappedKeysElements` = `{}`
 
-#### Defined in
+#### Source
 
 src/utils/KeyboardManager/index.ts:12
 
-___
+***
 
 ### \_options
 
-• `Private` **\_options**: `IKeyboardOptions`
+> `private` **\_options**: `IKeyboardOptions`
 
-#### Defined in
+#### Source
 
 src/utils/KeyboardManager/index.ts:11
 
@@ -70,7 +54,7 @@ src/utils/KeyboardManager/index.ts:11
 
 ### mappedKeys
 
-• `get` **mappedKeys**(): `IGetMappedKeys`[]
+> `get` **mappedKeys**(): `IGetMappedKeys`[]
 
 Obtém as chaves mapeadas.
 
@@ -80,25 +64,31 @@ Obtém as chaves mapeadas.
 
 chaves mapeadas com descrições
 
-#### Defined in
+#### Source
 
 src/utils/KeyboardManager/index.ts:97
 
 ## Methods
 
-### bind
+### bind()
 
-▸ **bind**(`keyMap`, `callback`, `options?`): [`KeyboardManager`](KeyboardManager.md)
+> **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. |
+• **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
 
@@ -106,24 +96,27 @@ Associa um evento de teclado com uma função
 
 O objeto `KeyboardManager`
 
-#### Defined in
+#### Source
 
 src/utils/KeyboardManager/index.ts:37
 
-___
+***
 
-### checkModifiersIsApplied
+### checkModifiersIsApplied()
 
-▸ `Private` **checkModifiersIsApplied**(`event`, `modifiedList`): `boolean`
+> `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 |
+• **event**: `KeyboardEvent`
+
+O evento de teclado
+
+• **modifiedList**: `string`[]
+
+As teclas modificadoras
 
 #### Returns
 
@@ -131,49 +124,61 @@ Verifica se todas as teclas modificadoras foram aplicadas ao evento
 
 Retorna se todas as teclas modificadoras foram aplicadas
 
-#### Defined in
+#### Source
 
 src/utils/KeyboardManager/index.ts:166
 
-___
+***
 
-### handleListenerEvent
+### handleListenerEvent()
 
-▸ `Private` **handleListenerEvent**(`keyMap`, `callback`, `propagate`, `event`): `void`
+> `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 |
+• **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
+#### Source
 
 src/utils/KeyboardManager/index.ts:113
 
-___
+***
 
-### keyAppliedWithModifiers
+### keyAppliedWithModifiers()
 
-▸ `Private` **keyAppliedWithModifiers**(`keyMap`, `pressedKeyCode`): `IKeyAppliedResponse`
+> `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 |
+• **keyMap**: `string`
+
+Chave de mapeamento de teclado
+
+• **pressedKeyCode**: `number`
+
+Código do evento de teclado pressionado
 
 #### Returns
 
@@ -181,23 +186,23 @@ Verifica se um evento de teclado foi disparado
 
 Retorna se o evento de teclado foi disparado e as teclas modificadoras aplicadas ao evento
 
-#### Defined in
+#### Source
 
 src/utils/KeyboardManager/index.ts:129
 
-___
+***
 
-### unbind
+### unbind()
 
-▸ **unbind**(`keyMap`): [`KeyboardManager`](KeyboardManager.md)
+> **unbind**(`keyMap`): [`KeyboardManager`](KeyboardManager.md)
 
 Remove um evento de teclado
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `keyMap` | `string` | Chave de mapeamento de teclado. |
+• **keyMap**: `string`
+
+Chave de mapeamento de teclado.
 
 #### Returns
 
@@ -205,29 +210,32 @@ Remove um evento de teclado
 
 - O objeto `KeyboardManager`
 
-#### Defined in
+#### Source
 
 src/utils/KeyboardManager/index.ts:73
 
-___
+***
 
-### verifyAndStopPropagation
+### verifyAndStopPropagation()
 
-▸ `Private` **verifyAndStopPropagation**(`event`, `propagate`): `void`
+> `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 |
+• **event**: `KeyboardEvent`
+
+O evento de teclado
+
+• **propagate**: `boolean`
+
+Se o evento de teclado deve ser propagado
 
 #### Returns
 
 `void`
 
-#### Defined in
+#### Source
 
 src/utils/KeyboardManager/index.ts:202