@sankhyalabs/core-docs 0.0.0-bugfix-dev-KB-6165.0

package/classes/ReadyUtil.md

@@ -0,0 +1,115 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / ReadyUtil
+
+# 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)
+
+### Properties
+
+- [promise](ReadyUtil.md#promise)
+- [resolve](ReadyUtil.md#resolve)
+
+### Methods
+
+- [clean](ReadyUtil.md#clean)
+- [end](ReadyUtil.md#end)
+- [start](ReadyUtil.md#start)
+- [whenReady](ReadyUtil.md#whenready)
+
+## Constructors
+
+### constructor
+
+• **new ReadyUtil**()
+
+## Properties
+
+### promise
+
+• `Private` **promise**: `any`
+
+#### Defined in
+
+src/utils/ReadyUtil.ts:6
+
+___
+
+### resolve
+
+• `Private` **resolve**: `any`
+
+#### Defined in
+
+src/utils/ReadyUtil.ts:5
+
+## Methods
+
+### clean
+
+▸ `Private` **clean**(): `void`
+
+Limpa o estado da instancia ao finalizar a execução do processo registrado.
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/utils/ReadyUtil.ts:11
+
+___
+
+### end
+
+▸ **end**(): `void`
+
+Executa processo atribuído.
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/utils/ReadyUtil.ts:28
+
+___
+
+### start
+
+▸ `Private` **start**(): `void`
+
+Inicializa o estado da instancia ao registrar processo.
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/utils/ReadyUtil.ts:19
+
+___
+
+### whenReady
+
+▸ **whenReady**(): `Promise`<`unknown`\>
+
+Atribui processo que será executado por operações que o invocarem no método 'end'.
+
+#### Returns
+
+`Promise`<`unknown`\>
+
+Promise que deve conter o código do processo.
+
+#### Defined in
+
+src/utils/ReadyUtil.ts:36

package/classes/RequestMetadata.md

@@ -0,0 +1,84 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / RequestMetadata
+
+# Class: RequestMetadata
+
+Representa as propriedades necessárias para se executar uma requisição.
+
+## Table of contents
+
+### Constructors
+
+- [constructor](RequestMetadata.md#constructor)
+
+### Properties
+
+- [headers](RequestMetadata.md#headers)
+- [method](RequestMetadata.md#method)
+- [timeout](RequestMetadata.md#timeout)
+- [url](RequestMetadata.md#url)
+
+## Constructors
+
+### constructor
+
+• **new RequestMetadata**(`url`, `method`, `headers?`)
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `url` | `string` | A URL que deve ser chamada. |
+| `method` | `Method` | O Método da requisição (GET, PUT, POST ou DELETE). |
+| `headers?` | `Header`[] | - |
+
+#### Defined in
+
+src/http/RequestMetadata.ts:22
+
+## Properties
+
+### headers
+
+• **headers**: `Header`[]
+
+Headers para serem enviados na requisição
+
+#### Defined in
+
+src/http/RequestMetadata.ts:16
+
+___
+
+### method
+
+• **method**: `Method`
+
+O verbo HTTP
+
+#### Defined in
+
+src/http/RequestMetadata.ts:10
+
+___
+
+### timeout
+
+• **timeout**: `number` = `30000`
+
+Tempo limite de espera pela resposta
+
+#### Defined in
+
+src/http/RequestMetadata.ts:13
+
+___
+
+### url
+
+• **url**: `string`
+
+A URL a ser chamada
+
+#### Defined in
+
+src/http/RequestMetadata.ts:7

package/classes/SelectionInfo.md

@@ -0,0 +1,168 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / SelectionInfo
+
+# Class: SelectionInfo
+
+## Table of contents
+
+### Constructors
+
+- [constructor](SelectionInfo.md#constructor)
+
+### Properties
+
+- [\_records](SelectionInfo.md#_records)
+- [\_total](SelectionInfo.md#_total)
+- [filters](SelectionInfo.md#filters)
+- [mode](SelectionInfo.md#mode)
+- [sort](SelectionInfo.md#sort)
+
+### Accessors
+
+- [length](SelectionInfo.md#length)
+- [recordIds](SelectionInfo.md#recordids)
+- [records](SelectionInfo.md#records)
+
+### Methods
+
+- [isAllRecords](SelectionInfo.md#isallrecords)
+- [isEmpty](SelectionInfo.md#isempty)
+
+## Constructors
+
+### constructor
+
+• **new SelectionInfo**(`records`, `mode?`, `total?`, `filters?`, `sort?`)
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `records` | [`Record`](../interfaces/Record.md)[] | `undefined` |
+| `mode` | [`SelectionMode`](../enums/SelectionMode.md) | `SelectionMode.SOME_RECORDS` |
+| `total?` | `number` | `undefined` |
+| `filters?` | [`Filter`](../interfaces/Filter.md)[] | `undefined` |
+| `sort?` | [`Sort`](../interfaces/Sort.md)[] | `undefined` |
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1796
+
+## Properties
+
+### \_records
+
+• `Private` **\_records**: [`Record`](../interfaces/Record.md)[]
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1790
+
+___
+
+### \_total
+
+• `Private` `Optional` **\_total**: `number`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1792
+
+___
+
+### filters
+
+• `Optional` **filters**: [`Filter`](../interfaces/Filter.md)[]
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1793
+
+___
+
+### mode
+
+• **mode**: [`SelectionMode`](../enums/SelectionMode.md)
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1791
+
+___
+
+### sort
+
+• `Optional` **sort**: [`Sort`](../interfaces/Sort.md)[]
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1794
+
+## Accessors
+
+### length
+
+• `get` **length**(): `number`
+
+#### Returns
+
+`number`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1821
+
+___
+
+### recordIds
+
+• `get` **recordIds**(): `undefined` \| `string`[]
+
+#### Returns
+
+`undefined` \| `string`[]
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1811
+
+___
+
+### records
+
+• `get` **records**(): `undefined` \| [`Record`](../interfaces/Record.md)[]
+
+#### Returns
+
+`undefined` \| [`Record`](../interfaces/Record.md)[]
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1804
+
+## Methods
+
+### isAllRecords
+
+▸ **isAllRecords**(): `boolean`
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1828
+
+___
+
+### isEmpty
+
+▸ **isEmpty**(): `boolean`
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1832

package/classes/SkwHttpProvider.md

@@ -0,0 +1,109 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / SkwHttpProvider
+
+# Class: SkwHttpProvider
+
+## Table of contents
+
+### Constructors
+
+- [constructor](SkwHttpProvider.md#constructor)
+
+### Properties
+
+- [STATUS\_CANCELED](SkwHttpProvider.md#status_canceled)
+- [STATUS\_ERROR](SkwHttpProvider.md#status_error)
+- [STATUS\_INFO](SkwHttpProvider.md#status_info)
+- [STATUS\_OK](SkwHttpProvider.md#status_ok)
+- [STATUS\_TIMEOUT](SkwHttpProvider.md#status_timeout)
+- [\_counter](SkwHttpProvider.md#_counter)
+
+### Methods
+
+- [callService](SkwHttpProvider.md#callservice)
+
+## Constructors
+
+### constructor
+
+• **new SkwHttpProvider**()
+
+## Properties
+
+### STATUS\_CANCELED
+
+▪ `Static` **STATUS\_CANCELED**: `number` = `4`
+
+#### Defined in
+
+src/http/SkwHttpProvider.ts:11
+
+___
+
+### STATUS\_ERROR
+
+▪ `Static` **STATUS\_ERROR**: `number` = `0`
+
+#### Defined in
+
+src/http/SkwHttpProvider.ts:7
+
+___
+
+### STATUS\_INFO
+
+▪ `Static` **STATUS\_INFO**: `number` = `2`
+
+#### Defined in
+
+src/http/SkwHttpProvider.ts:9
+
+___
+
+### STATUS\_OK
+
+▪ `Static` **STATUS\_OK**: `number` = `1`
+
+#### Defined in
+
+src/http/SkwHttpProvider.ts:8
+
+___
+
+### STATUS\_TIMEOUT
+
+▪ `Static` **STATUS\_TIMEOUT**: `number` = `3`
+
+#### Defined in
+
+src/http/SkwHttpProvider.ts:10
+
+___
+
+### \_counter
+
+▪ `Static` **\_counter**: `number` = `0`
+
+#### Defined in
+
+src/http/SkwHttpProvider.ts:5
+
+## Methods
+
+### callService
+
+▸ `Static` **callService**(`serviceName`, `content`): `Promise`<`Object`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `serviceName` | `string` |
+| `content` | `Object` |
+
+#### Returns
+
+`Promise`<`Object`\>
+
+#### Defined in
+
+src/http/SkwHttpProvider.ts:13