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

package/README.md

@@ -1,4 +1,6 @@
-@sankhyalabs/core / [Exports](modules.md)
+**@sankhyalabs/core** • [**Docs**](globals.md)
+
+***
 
 # @sankhyalabs/core
 

package/classes/ApplicationContext.md

@@ -1,41 +1,37 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / ApplicationContext
+[**@sankhyalabs/core**](../README.md) • **Docs**
+
+***
+
+[@sankhyalabs/core](../globals.md) / ApplicationContext
 
 # Class: ApplicationContext
 
 `ApplicationContext`: Utilizado para manipulação do contexto.
 - Evitar uso da classe sem alinhamento com a arquitetura devido ao uso de variáveis globais.
 
-## Table of contents
-
-### Constructors
-
-- [constructor](ApplicationContext.md#constructor)
-
-### Methods
+## Constructors
 
-- [getContextValue](ApplicationContext.md#getcontextvalue)
-- [getCtx](ApplicationContext.md#getctx)
-- [setContextValue](ApplicationContext.md#setcontextvalue)
+### new ApplicationContext()
 
-## Constructors
+> **new ApplicationContext**(): [`ApplicationContext`](ApplicationContext.md)
 
-### constructor
+#### Returns
 
-• **new ApplicationContext**()
+[`ApplicationContext`](ApplicationContext.md)
 
 ## Methods
 
-### getContextValue
+### getContextValue()
 
-▸ `Static` **getContextValue**(`key`): `any`
+> `static` **getContextValue**(`key`): `any`
 
 Obtém informação específica do contexto.
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `key` | `string` | Chave do contexto desejada. |
+• **key**: `string`
+
+Chave do contexto desejada.
 
 #### Returns
 
@@ -43,15 +39,15 @@ Obtém informação específica do contexto.
 
 - Informação do contexto desejado.
 
-#### Defined in
+#### Source
 
 src/utils/ApplicationContext.ts:13
 
-___
+***
 
-### getCtx
+### getCtx()
 
-▸ `Static` `Private` **getCtx**(): `any`
+> `static` `private` **getCtx**(): `any`
 
 Obtém o contexto global da aplicação sankhyacore.
 - Esse contexto pode ser entendido como um ponto de coesão para atores que não se conhecem poderem trocar informação. Assim, o código x busca por um possível valor no contexto. Se essa informação estiver lá, ele reage de certa forma. O código Y, sabe dessa necessidade mas não consegue passar essa informação diretamente, então atribui o valor ao contexto.
@@ -62,29 +58,32 @@ Obtém o contexto global da aplicação sankhyacore.
 
 - Objeto com as propriedades da variável global ___snkcore___ctx___.
 
-#### Defined in
+#### Source
 
 src/utils/ApplicationContext.ts:32
 
-___
+***
 
-### setContextValue
+### setContextValue()
 
-▸ `Static` **setContextValue**(`key`, `value`): `any`
+> `static` **setContextValue**(`key`, `value`): `any`
 
 Aplica informação no contexto.
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `key` | `string` | Identificador do contexto. |
-| `value` | `any` | Informação a ser inserida no contexto. |
+• **key**: `string`
+
+Identificador do contexto.
+
+• **value**: `any`
+
+Informação a ser inserida no contexto.
 
 #### Returns
 
 `any`
 
-#### Defined in
+#### Source
 
 src/utils/ApplicationContext.ts:23

package/classes/ArrayUtils.md

@@ -1,48 +1,48 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / ArrayUtils
+[**@sankhyalabs/core**](../README.md) • **Docs**
 
-# Class: ArrayUtils
-
-`ArrayUtils`: Utilitário com a responsabilidade de manipular Arrays.
+***
 
-## Table of contents
+[@sankhyalabs/core](../globals.md) / ArrayUtils
 
-### Constructors
+# Class: ArrayUtils
 
-- [constructor](ArrayUtils.md#constructor)
+`ArrayUtils`: Utilitário com a responsabilidade de manipular Arrays.
 
-### Methods
+## Constructors
 
-- [applyStringFilter](ArrayUtils.md#applystringfilter)
-- [find](ArrayUtils.md#find)
-- [indexOf](ArrayUtils.md#indexof)
-- [isIn](ArrayUtils.md#isin)
-- [normalizeSearchString](ArrayUtils.md#normalizesearchstring)
-- [removeAtIndex](ArrayUtils.md#removeatindex)
-- [removeReference](ArrayUtils.md#removereference)
-- [sortAlphabetically](ArrayUtils.md#sortalphabetically)
+### new ArrayUtils()
 
-## Constructors
+> **new ArrayUtils**(): [`ArrayUtils`](ArrayUtils.md)
 
-### constructor
+#### Returns
 
-• **new ArrayUtils**()
+[`ArrayUtils`](ArrayUtils.md)
 
 ## Methods
 
-### applyStringFilter
+### applyStringFilter()
 
-▸ `Static` **applyStringFilter**(`argument`, `originalArray`, `alphabeticalSorting?`, `fieldName?`): `any`[]
+> `static` **applyStringFilter**(`argument`, `originalArray`, `alphabeticalSorting`, `fieldName`): `any`[]
 
 Filtra um array a partir de um critério textual.
 
 #### Parameters
 
-| Name | Type | Default value | Description |
-| :------ | :------ | :------ | :------ |
-| `argument` | `string` | `undefined` | Texto a ser usado no filtro. |
-| `originalArray` | `any`[] | `undefined` | Array no formato original. |
-| `alphabeticalSorting` | `boolean` | `true` | Determina se o resultado deve ser ordenado ou mantido na ordem original. Por padrão ordena. |
-| `fieldName` | `string` | `"label"` | Caso o objeto deva ser filtrado por um campo diferente de "label", pode-se usar esse parâmetro. |
+• **argument**: `string`
+
+Texto a ser usado no filtro.
+
+• **originalArray**: `any`[]
+
+Array no formato original.
+
+• **alphabeticalSorting**: `boolean`= `true`
+
+Determina se o resultado deve ser ordenado ou mantido na ordem original. Por padrão ordena.
+
+• **fieldName**: `string`= `"label"`
+
+Caso o objeto deva ser filtrado por um campo diferente de "label", pode-se usar esse parâmetro.
 
 #### Returns
 
@@ -50,24 +50,25 @@ Filtra um array a partir de um critério textual.
 
 - Um array filtrado e ordenado conforme necessidade..
 
-#### Defined in
+#### Source
 
 src/utils/ArrayUtils.ts:18
 
-___
+***
 
-### find
+### find()
 
-▸ `Static` **find**(`arr`, `checkerFn`): `any`
+> `static` **find**(`arr`, `checkerFn`): `any`
 
 Ordena valores de um array alfabeticamente.
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `arr` | `any` | Array a ser ordenado. |
-| `checkerFn` | `any` | - |
+• **arr**: `any`
+
+Array a ser ordenado.
+
+• **checkerFn**: `any`
 
 #### Returns
 
@@ -75,24 +76,27 @@ Ordena valores de um array alfabeticamente.
 
 - Array ordenado alfabeticamente..
 
-#### Defined in
+#### Source
 
 src/utils/ArrayUtils.ts:69
 
-___
+***
 
-### indexOf
+### indexOf()
 
-▸ `Static` **indexOf**(`arr`, `obj`): `number`
+> `static` **indexOf**(`arr`, `obj`): `number`
 
 Retorna o objeto se for encontrado no array, ou -1 se não for encontrado.
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `arr` | `any` | Array onde está o objeto. |
-| `obj` | `any` | Objeto a ser procurado. |
+• **arr**: `any`
+
+Array onde está o objeto.
+
+• **obj**: `any`
+
+Objeto a ser procurado.
 
 #### Returns
 
@@ -100,24 +104,25 @@ Retorna o objeto se for encontrado no array, ou -1 se não for encontrado.
 
 - Array ordenado alfabeticamente..
 
-#### Defined in
+#### Source
 
 src/utils/ArrayUtils.ts:88
 
-___
+***
 
-### isIn
+### isIn()
 
-▸ `Static` **isIn**(`arr`, `obj`): `boolean`
+> `static` **isIn**(`arr`, `obj`): `boolean`
 
 Remove um objeto do array.
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `arr` | `any` | - |
-| `obj` | `any` | Objeto a ser removido. |
+• **arr**: `any`
+
+• **obj**: `any`
+
+Objeto a ser removido.
 
 #### Returns
 
@@ -125,23 +130,23 @@ Remove um objeto do array.
 
 - Array sem o Objeto informado.
 
-#### Defined in
+#### Source
 
 src/utils/ArrayUtils.ts:131
 
-___
+***
 
-### normalizeSearchString
+### normalizeSearchString()
 
-▸ `Static` `Private` **normalizeSearchString**(`original`): `string`
+> `static` `private` **normalizeSearchString**(`original`): `string`
 
 Converte texto para caixa alta e substitui caracteres acentuados.
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `original` | `string` | Texto a ser convertido. |
+• **original**: `string`
+
+Texto a ser convertido.
 
 #### Returns
 
@@ -149,24 +154,27 @@ Converte texto para caixa alta e substitui caracteres acentuados.
 
 - Texto com as letras acentuadas sem os acentos e em caixa alta.
 
-#### Defined in
+#### Source
 
 src/utils/ArrayUtils.ts:36
 
-___
+***
 
-### removeAtIndex
+### removeAtIndex()
 
-▸ `Static` **removeAtIndex**(`array`, `index`): `any`
+> `static` **removeAtIndex**(`array`, `index`): `any`
 
 Remove um item de array de acordo com o index.
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `array` | `any` | Array onde está o item. |
-| `index` | `number` | Index do item a ser removido. |
+• **array**: `any`
+
+Array onde está o item.
+
+• **index**: `number`
+
+Index do item a ser removido.
 
 #### Returns
 
@@ -174,24 +182,27 @@ Remove um item de array de acordo com o index.
 
 - Array sem o item do index informado.
 
-#### Defined in
+#### Source
 
 src/utils/ArrayUtils.ts:106
 
-___
+***
 
-### removeReference
+### removeReference()
 
-▸ `Static` **removeReference**(`array`, `obj`): `any`
+> `static` **removeReference**(`array`, `obj`): `any`
 
 Remove um objeto do array.
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `array` | `any` | Array onde está o objeto. |
-| `obj` | `any` | Objeto a ser removido. |
+• **array**: `any`
+
+Array onde está o objeto.
+
+• **obj**: `any`
+
+Objeto a ser removido.
 
 #### Returns
 
@@ -199,24 +210,25 @@ Remove um objeto do array.
 
 - Array sem o Objeto informado.
 
-#### Defined in
+#### Source
 
 src/utils/ArrayUtils.ts:119
 
-___
+***
 
-### sortAlphabetically
+### sortAlphabetically()
 
-▸ `Static` **sortAlphabetically**(`originalArray`, `fieldName?`): `any`[]
+> `static` **sortAlphabetically**(`originalArray`, `fieldName`): `any`[]
 
 Ordena valores de um array alfabeticamente.
 
 #### Parameters
 
-| Name | Type | Default value | Description |
-| :------ | :------ | :------ | :------ |
-| `originalArray` | `any`[] | `undefined` | Array a ser ordenado. |
-| `fieldName` | `string` | `"label"` | - |
+• **originalArray**: `any`[]
+
+Array a ser ordenado.
+
+• **fieldName**: `string`= `"label"`
 
 #### Returns
 
@@ -224,6 +236,6 @@ Ordena valores de um array alfabeticamente.
 
 - Array ordenado alfabeticamente..
 
-#### Defined in
+#### Source
 
 src/utils/ArrayUtils.ts:46

package/classes/AuthorizedServiceCaller.md

@@ -1,36 +1,28 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / AuthorizedServiceCaller
+[**@sankhyalabs/core**](../README.md) • **Docs**
 
-# Class: AuthorizedServiceCaller
-
-## Table of contents
-
-### Constructors
+***
 
-- [constructor](AuthorizedServiceCaller.md#constructor)
+[@sankhyalabs/core](../globals.md) / AuthorizedServiceCaller
 
-### Properties
+# Class: AuthorizedServiceCaller
 
-- [serverURL](AuthorizedServiceCaller.md#serverurl)
-- [unauthorizedPath](AuthorizedServiceCaller.md#unauthorizedpath)
+## Constructors
 
-### Methods
+### new AuthorizedServiceCaller()
 
-- [requestService](AuthorizedServiceCaller.md#requestservice)
+> **new AuthorizedServiceCaller**(`serverURL`, `unauthorizedPath`): [`AuthorizedServiceCaller`](AuthorizedServiceCaller.md)
 
-## Constructors
+#### Parameters
 
-### constructor
+• **serverURL**: `string`
 
-• **new AuthorizedServiceCaller**(`serverURL`, `unauthorizedPath`)
+• **unauthorizedPath**: `string`
 
-#### Parameters
+#### Returns
 
-| Name | Type |
-| :------ | :------ |
-| `serverURL` | `string` |
-| `unauthorizedPath` | `string` |
+[`AuthorizedServiceCaller`](AuthorizedServiceCaller.md)
 
-#### Defined in
+#### Source
 
 src/http/AuthorizedServiceCaller.ts:6
 
@@ -38,39 +30,38 @@ src/http/AuthorizedServiceCaller.ts:6
 
 ### serverURL
 
-• `Private` **serverURL**: `string` = `"http://192.168.1.218:8503"`
+> `private` **serverURL**: `string` = `"http://192.168.1.218:8503"`
 
-#### Defined in
+#### Source
 
 src/http/AuthorizedServiceCaller.ts:3
 
-___
+***
 
 ### unauthorizedPath
 
-• `Private` **unauthorizedPath**: `string` = `"/"`
+> `private` **unauthorizedPath**: `string` = `"/"`
 
-#### Defined in
+#### Source
 
 src/http/AuthorizedServiceCaller.ts:4
 
 ## Methods
 
-### requestService
+### requestService()
 
-▸ **requestService**(`request`, `callback?`): `Promise`<`void` \| `Response`\>
+> **requestService**(`request`, `callback`?): `Promise`\<`void` \| `Response`\>
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `request` | `AuthorizedRequest` |
-| `callback?` | `Function` |
+• **request**: `AuthorizedRequest`
+
+• **callback?**: `Function`
 
 #### Returns
 
-`Promise`<`void` \| `Response`\>
+`Promise`\<`void` \| `Response`\>
 
-#### Defined in
+#### Source
 
 src/http/AuthorizedServiceCaller.ts:12