@sankhyalabs/core-docs 5.20.0-dev.4 → 5.20.0-dev.6

package/classes/ObjectUtils.md

@@ -1,49 +1,40 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / ObjectUtils
+[**@sankhyalabs/core**](../README.md) • **Docs**
 
-# Class: ObjectUtils
-
-`ObjectUtils`: Utilizado para manipulação de objetos.
+***
 
-## Table of contents
+[@sankhyalabs/core](../globals.md) / ObjectUtils
 
-### Constructors
+# Class: ObjectUtils
 
-- [constructor](ObjectUtils.md#constructor)
+`ObjectUtils`: Utilizado para manipulação de objetos.
 
-### Methods
+## Constructors
 
-- [copy](ObjectUtils.md#copy)
-- [equals](ObjectUtils.md#equals)
-- [objectToString](ObjectUtils.md#objecttostring)
-- [removeEmptyValues](ObjectUtils.md#removeemptyvalues)
-- [sortByProperty](ObjectUtils.md#sortbyproperty)
-- [stringToObject](ObjectUtils.md#stringtoobject)
+### new ObjectUtils()
 
-## Constructors
+> **new ObjectUtils**(): [`ObjectUtils`](ObjectUtils.md)
 
-### constructor
+#### Returns
 
-• **new ObjectUtils**()
+[`ObjectUtils`](ObjectUtils.md)
 
 ## Methods
 
-### copy
+### copy()
 
-▸ `Static` **copy**<`T`\>(`data`): `T`
+> `static` **copy**\<`T`\>(`data`): `T`
 
 Faz a cópia do objeto.
 
 #### Type parameters
 
-| Name |
-| :------ |
-| `T` |
+• **T**
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `data` | `Object` \| `Object`[] | Objeto a ser copiado. |
+• **data**: `Object` \| `Object`[]
+
+Objeto a ser copiado.
 
 #### Returns
 
@@ -51,24 +42,27 @@ Faz a cópia do objeto.
 
 - A cópia do objeto válido.
 
-#### Defined in
+#### Source
 
 src/utils/ObjectUtils.ts:13
 
-___
+***
 
-### equals
+### equals()
 
-▸ `Static` **equals**(`obj1`, `obj2`): `any`
+> `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. |
+• **obj1**: `any`
+
+Objeto a ser comparado.
+
+• **obj2**: `any`
+
+Objeto a ser comparado.
 
 #### Returns
 
@@ -76,27 +70,23 @@ Compara se um objeto é igual a outro objeto.
 
 - Se o objeto 1 é igual ao objeto 2.
 
-#### Defined in
+#### Source
 
 src/utils/ObjectUtils.ts:84
 
-___
+***
 
-### objectToString
+### objectToString()
 
-▸ `Static` **objectToString**(`data`): `string`
+> `static` **objectToString**(`data`): `string`
 
 Converte um objeto em string/JSON.
 
-**`Example`**
-
-@Informado: ```{nome : "Sankhya", cidade: "Uberlandia"}``` | Obtenho: ```"{"nome" : "Sankhya", "cidade":"Uberlandia"}"```
-
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `data` | `Object` \| `Object`[] | Objeto a ser convertido. |
+• **data**: `Object` \| `Object`[]
+
+Objeto a ser convertido.
 
 #### Returns
 
@@ -104,23 +94,25 @@ Converte um objeto em string/JSON.
 
 - Uma string JSON.
 
-#### Defined in
+#### Example
+
+@Informado: ```{nome : "Sankhya", cidade: "Uberlandia"}``` | Obtenho: ```"{"nome" : "Sankhya", "cidade":"Uberlandia"}"```
+
+#### Source
 
 src/utils/ObjectUtils.ts:26
 
-___
+***
 
-### removeEmptyValues
+### removeEmptyValues()
 
-▸ `Static` **removeEmptyValues**(`obj`): `object`
+> `static` **removeEmptyValues**(`obj`): `object`
 
 Remove atributos nulos e indefinidos de um objeto.
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `obj` | `object` |
+• **obj**: `object`
 
 #### Returns
 
@@ -128,24 +120,27 @@ Remove atributos nulos e indefinidos de um objeto.
 
 - O objeto com as propriedades válidas.
 
-#### Defined in
+#### Source
 
 src/utils/ObjectUtils.ts:68
 
-___
+***
 
-### sortByProperty
+### sortByProperty()
 
-▸ `Static` **sortByProperty**(`data`, `property`): `any`
+> `static` **sortByProperty**(`data`, `property`): `any`
 
 Faz a ordenação de um objeto por uma propriedade.
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `data` | `any` | Objeto a ser ordenado. |
-| `property` | `string` | Nome da propriedade a ser ordenada. |
+• **data**: `any`
+
+Objeto a ser ordenado.
+
+• **property**: `string`
+
+Nome da propriedade a ser ordenada.
 
 #### Returns
 
@@ -153,27 +148,23 @@ Faz a ordenação de um objeto por uma propriedade.
 
 - O objeto ordenado pela propriedade.
 
-#### Defined in
+#### Source
 
 src/utils/ObjectUtils.ts:50
 
-___
+***
 
-### stringToObject
+### stringToObject()
 
-▸ `Static` **stringToObject**(`data`): `Object` \| `Object`[]
+> `static` **stringToObject**(`data`): `Object` \| `Object`[]
 
 Converte uma string/JSON em objeto.
 
-**`Example`**
-
-Informado: ```"{"nome" : "Sankhya", "cidade":"Uberlandia"}"``` | Obtenho: ```{nome : "Sankhya", cidade: "Uberlandia"}```
-
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `data` | `string` | String a ser convertida. |
+• **data**: `string`
+
+String a ser convertida.
 
 #### Returns
 
@@ -181,6 +172,10 @@ Informado: ```"{"nome" : "Sankhya", "cidade":"Uberlandia"}"``` | Obtenho: ```{no
 
 - Um objeto válido.
 
-#### Defined in
+#### Example
+
+Informado: ```"{"nome" : "Sankhya", "cidade":"Uberlandia"}"``` | Obtenho: ```{nome : "Sankhya", cidade: "Uberlandia"}```
+
+#### Source
 
 src/utils/ObjectUtils.ts:39

package/classes/OnboardingUtils.md

@@ -1,32 +1,22 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / OnboardingUtils
+[**@sankhyalabs/core**](../README.md) • **Docs**
 
-# Class: OnboardingUtils
-
-## Table of contents
-
-### Constructors
+***
 
-- [constructor](OnboardingUtils.md#constructor)
+[@sankhyalabs/core](../globals.md) / OnboardingUtils
 
-### Properties
-
-- [USER\_GUIDE\_TAG\_ID](OnboardingUtils.md#user_guide_tag_id)
-- [instance](OnboardingUtils.md#instance)
+# Class: OnboardingUtils
 
-### Methods
+## Constructors
 
-- [init](OnboardingUtils.md#init)
-- [injectScript](OnboardingUtils.md#injectscript)
-- [register](OnboardingUtils.md#register)
-- [getInstance](OnboardingUtils.md#getinstance)
+### new OnboardingUtils()
 
-## Constructors
+> `private` **new OnboardingUtils**(): [`OnboardingUtils`](OnboardingUtils.md)
 
-### constructor
+#### Returns
 
-• `Private` **new OnboardingUtils**()
+[`OnboardingUtils`](OnboardingUtils.md)
 
-#### Defined in
+#### Source
 
 src/utils/OnboardingUtils.ts:5
 
@@ -34,93 +24,88 @@ src/utils/OnboardingUtils.ts:5
 
 ### USER\_GUIDE\_TAG\_ID
 
-▪ `Static` `Private` `Readonly` **USER\_GUIDE\_TAG\_ID**: ``"userGuideSnippet"``
+> `static` `private` `readonly` **USER\_GUIDE\_TAG\_ID**: `"userGuideSnippet"` = `"userGuideSnippet"`
 
-#### Defined in
+#### Source
 
 src/utils/OnboardingUtils.ts:2
 
-___
+***
 
 ### instance
 
-▪ `Static` `Private` **instance**: [`OnboardingUtils`](OnboardingUtils.md)
+> `static` `private` **instance**: [`OnboardingUtils`](OnboardingUtils.md)
 
-#### Defined in
+#### Source
 
 src/utils/OnboardingUtils.ts:3
 
 ## Methods
 
-### init
+### init()
 
-▸ **init**(`apiKey`, `ctx`): `Promise`<`void`\>
+> **init**(`apiKey`, `ctx`): `Promise`\<`void`\>
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `apiKey` | `string` |
-| `ctx` | `EnvironmentContext` |
+• **apiKey**: `string`
+
+• **ctx**: `EnvironmentContext`
 
 #### Returns
 
-`Promise`<`void`\>
+`Promise`\<`void`\>
 
-#### Defined in
+#### Source
 
 src/utils/OnboardingUtils.ts:14
 
-___
+***
 
-### injectScript
+### injectScript()
 
-▸ `Private` **injectScript**(`apiKey`): `void`
+> `private` **injectScript**(`apiKey`): `void`
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `apiKey` | `string` |
+• **apiKey**: `string`
 
 #### Returns
 
 `void`
 
-#### Defined in
+#### Source
 
 src/utils/OnboardingUtils.ts:23
 
-___
+***
 
-### register
+### register()
 
-▸ `Private` **register**(`ctx`): `void`
+> `private` **register**(`ctx`): `void`
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `ctx` | `EnvironmentContext` |
+• **ctx**: `EnvironmentContext`
 
 #### Returns
 
 `void`
 
-#### Defined in
+#### Source
 
 src/utils/OnboardingUtils.ts:34
 
-___
+***
 
-### getInstance
+### getInstance()
 
-▸ `Static` **getInstance**(): [`OnboardingUtils`](OnboardingUtils.md)
+> `static` **getInstance**(): [`OnboardingUtils`](OnboardingUtils.md)
 
 #### Returns
 
 [`OnboardingUtils`](OnboardingUtils.md)
 
-#### Defined in
+#### Source
 
 src/utils/OnboardingUtils.ts:7

package/classes/PromiseSync.md

@@ -1,50 +1,33 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / PromiseSync
+[**@sankhyalabs/core**](../README.md) • **Docs**
 
-# Class: PromiseSync<T\>
+***
+
+[@sankhyalabs/core](../globals.md) / PromiseSync
+
+# Class: PromiseSync\<T\>
 
 O intuito desta classe é organizar a finalização de várias
 promessas executando determinada ação (callback) com o resultado.
 
 ## Type parameters
 
-| Name |
-| :------ |
-| `T` |
-
-## Table of contents
-
-### Constructors
-
-- [constructor](PromiseSync.md#constructor)
-
-### Properties
-
-- [\_callBack](PromiseSync.md#_callback)
-- [\_promises](PromiseSync.md#_promises)
-
-### Methods
-
-- [add](PromiseSync.md#add)
+• **T**
 
 ## Constructors
 
-### constructor
+### new PromiseSync()
 
-• **new PromiseSync**<`T`\>(`callBack`)
+> **new PromiseSync**\<`T`\>(`callBack`): [`PromiseSync`](PromiseSync.md)\<`T`\>
 
-#### Type parameters
+#### Parameters
 
-| Name |
-| :------ |
-| `T` |
+• **callBack**: [`PromiseSyncCallback`](../interfaces/PromiseSyncCallback.md)\<`T`\>
 
-#### Parameters
+#### Returns
 
-| Name | Type |
-| :------ | :------ |
-| `callBack` | [`PromiseSyncCallback`](../interfaces/PromiseSyncCallback.md)<`T`\> |
+[`PromiseSync`](PromiseSync.md)\<`T`\>
 
-#### Defined in
+#### Source
 
 src/async/PromiseSync.ts:13
 
@@ -52,40 +35,40 @@ src/async/PromiseSync.ts:13
 
 ### \_callBack
 
-• **\_callBack**: [`PromiseSyncCallback`](../interfaces/PromiseSyncCallback.md)<`T`\>
+> **\_callBack**: [`PromiseSyncCallback`](../interfaces/PromiseSyncCallback.md)\<`T`\>
 
-#### Defined in
+#### Source
 
 src/async/PromiseSync.ts:8
 
-___
+***
 
 ### \_promises
 
-• **\_promises**: `Promise`<`T`\>[]
+> **\_promises**: `Promise`\<`T`\>[]
 
-#### Defined in
+#### Source
 
 src/async/PromiseSync.ts:7
 
 ## Methods
 
-### add
+### add()
 
-▸ **add**(`promise`): `void`
+> **add**(`promise`): `void`
 
 Adiciona na lista de promises pendentes. Isso faz com que criemos uma nova espera.
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `promise` | `Promise`<`T`\> | Entrará na lista aguardada. |
+• **promise**: `Promise`\<`T`\>
+
+Entrará na lista aguardada.
 
 #### Returns
 
 `void`
 
-#### Defined in
+#### Source
 
 src/async/PromiseSync.ts:23

package/classes/ReadyUtil.md

@@ -1,58 +1,48 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / ReadyUtil
+[**@sankhyalabs/core**](../README.md) • **Docs**
 
-# Class: ReadyUtil
-
-`ReadyUtil`: Registra processos que serão invocados após a conclusão de operações.
-
-## Table of contents
-
-### Constructors
+***
 
-- [constructor](ReadyUtil.md#constructor)
+[@sankhyalabs/core](../globals.md) / ReadyUtil
 
-### Properties
+# Class: ReadyUtil
 
-- [promise](ReadyUtil.md#promise)
-- [resolve](ReadyUtil.md#resolve)
+`ReadyUtil`: Registra processos que serão invocados após a conclusão de operações.
 
-### Methods
+## Constructors
 
-- [clean](ReadyUtil.md#clean)
-- [end](ReadyUtil.md#end)
-- [start](ReadyUtil.md#start)
-- [whenReady](ReadyUtil.md#whenready)
+### new ReadyUtil()
 
-## Constructors
+> **new ReadyUtil**(): [`ReadyUtil`](ReadyUtil.md)
 
-### constructor
+#### Returns
 
-• **new ReadyUtil**()
+[`ReadyUtil`](ReadyUtil.md)
 
 ## Properties
 
 ### promise
 
-• `Private` **promise**: `any`
+> `private` **promise**: `any`
 
-#### Defined in
+#### Source
 
 src/utils/ReadyUtil.ts:6
 
-___
+***
 
 ### resolve
 
-• `Private` **resolve**: `any`
+> `private` **resolve**: `any`
 
-#### Defined in
+#### Source
 
 src/utils/ReadyUtil.ts:5
 
 ## Methods
 
-### clean
+### clean()
 
-▸ `Private` **clean**(): `void`
+> `private` **clean**(): `void`
 
 Limpa o estado da instancia ao finalizar a execução do processo registrado.
 
@@ -60,15 +50,15 @@ Limpa o estado da instancia ao finalizar a execução do processo registrado.
 
 `void`
 
-#### Defined in
+#### Source
 
 src/utils/ReadyUtil.ts:11
 
-___
+***
 
-### end
+### end()
 
-▸ **end**(): `void`
+> **end**(): `void`
 
 Executa processo atribuído.
 
@@ -76,15 +66,15 @@ Executa processo atribuído.
 
 `void`
 
-#### Defined in
+#### Source
 
 src/utils/ReadyUtil.ts:28
 
-___
+***
 
-### start
+### start()
 
-▸ `Private` **start**(): `void`
+> `private` **start**(): `void`
 
 Inicializa o estado da instancia ao registrar processo.
 
@@ -92,24 +82,24 @@ Inicializa o estado da instancia ao registrar processo.
 
 `void`
 
-#### Defined in
+#### Source
 
 src/utils/ReadyUtil.ts:19
 
-___
+***
 
-### whenReady
+### whenReady()
 
-▸ **whenReady**(): `Promise`<`unknown`\>
+> **whenReady**(): `Promise`\<`unknown`\>
 
 Atribui processo que será executado por operações que o invocarem no método 'end'.
 
 #### Returns
 
-`Promise`<`unknown`\>
+`Promise`\<`unknown`\>
 
 Promise que deve conter o código do processo.
 
-#### Defined in
+#### Source
 
 src/utils/ReadyUtil.ts:36