@sankhyalabs/core-docs 5.20.0-dev.3 → 5.20.0-dev.30

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

package/classes/RequestMetadata.md

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

package/classes/SearchUtils.md

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

package/classes/SelectionInfo.md

@@ -1,168 +1,153 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / SelectionInfo
+[**@sankhyalabs/core**](../README.md) • **Docs**
 
-# Class: SelectionInfo
-
-## Table of contents
+***
 
-### Constructors
+[@sankhyalabs/core](../globals.md) / SelectionInfo
 
-- [constructor](SelectionInfo.md#constructor)
+# Class: SelectionInfo
 
-### Properties
+## Constructors
 
-- [\_records](SelectionInfo.md#_records)
-- [\_total](SelectionInfo.md#_total)
-- [filters](SelectionInfo.md#filters)
-- [mode](SelectionInfo.md#mode)
-- [sort](SelectionInfo.md#sort)
+### new SelectionInfo()
 
-### Accessors
+> **new SelectionInfo**(`records`, `mode`, `total`?, `filters`?, `sort`?): [`SelectionInfo`](SelectionInfo.md)
 
-- [length](SelectionInfo.md#length)
-- [recordIds](SelectionInfo.md#recordids)
-- [records](SelectionInfo.md#records)
+#### Parameters
 
-### Methods
+• **records**: [`Record`](../interfaces/Record.md)[]
 
-- [isAllRecords](SelectionInfo.md#isallrecords)
-- [isEmpty](SelectionInfo.md#isempty)
+• **mode**: [`SelectionMode`](../enumerations/SelectionMode.md)= `SelectionMode.SOME_RECORDS`
 
-## Constructors
+• **total?**: `number`
 
-### constructor
+• **filters?**: [`Filter`](../interfaces/Filter.md)[]
 
-• **new SelectionInfo**(`records`, `mode?`, `total?`, `filters?`, `sort?`)
+• **sort?**: [`Sort`](../interfaces/Sort.md)[]
 
-#### Parameters
+#### Returns
 
-| 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` |
+[`SelectionInfo`](SelectionInfo.md)
 
-#### Defined in
+#### Source
 
-src/dataunit/DataUnit.ts:1871
+src/dataunit/DataUnit.ts:1927
 
 ## Properties
 
 ### \_records
 
-• `Private` **\_records**: [`Record`](../interfaces/Record.md)[]
+> `private` **\_records**: [`Record`](../interfaces/Record.md)[]
 
-#### Defined in
+#### Source
 
-src/dataunit/DataUnit.ts:1865
+src/dataunit/DataUnit.ts:1921
 
-___
+***
 
-### \_total
+### \_total?
 
-• `Private` `Optional` **\_total**: `number`
+> `private` `optional` **\_total**: `number`
 
-#### Defined in
+#### Source
 
-src/dataunit/DataUnit.ts:1867
+src/dataunit/DataUnit.ts:1923
 
-___
+***
 
-### filters
+### filters?
 
-• `Optional` **filters**: [`Filter`](../interfaces/Filter.md)[]
+> `optional` **filters**: [`Filter`](../interfaces/Filter.md)[]
 
-#### Defined in
+#### Source
 
-src/dataunit/DataUnit.ts:1868
+src/dataunit/DataUnit.ts:1924
 
-___
+***
 
 ### mode
 
-• **mode**: [`SelectionMode`](../enums/SelectionMode.md)
+> **mode**: [`SelectionMode`](../enumerations/SelectionMode.md)
 
-#### Defined in
+#### Source
 
-src/dataunit/DataUnit.ts:1866
+src/dataunit/DataUnit.ts:1922
 
-___
+***
 
-### sort
+### sort?
 
-• `Optional` **sort**: [`Sort`](../interfaces/Sort.md)[]
+> `optional` **sort**: [`Sort`](../interfaces/Sort.md)[]
 
-#### Defined in
+#### Source
 
-src/dataunit/DataUnit.ts:1869
+src/dataunit/DataUnit.ts:1925
 
 ## Accessors
 
 ### length
 
-• `get` **length**(): `number`
+> `get` **length**(): `number`
 
 #### Returns
 
 `number`
 
-#### Defined in
+#### Source
 
-src/dataunit/DataUnit.ts:1896
+src/dataunit/DataUnit.ts:1952
 
-___
+***
 
 ### recordIds
 
-• `get` **recordIds**(): `undefined` \| `string`[]
+> `get` **recordIds**(): `undefined` \| `string`[]
 
 #### Returns
 
 `undefined` \| `string`[]
 
-#### Defined in
+#### Source
 
-src/dataunit/DataUnit.ts:1886
+src/dataunit/DataUnit.ts:1942
 
-___
+***
 
 ### records
 
-• `get` **records**(): `undefined` \| [`Record`](../interfaces/Record.md)[]
+> `get` **records**(): `undefined` \| [`Record`](../interfaces/Record.md)[]
 
 #### Returns
 
 `undefined` \| [`Record`](../interfaces/Record.md)[]
 
-#### Defined in
+#### Source
 
-src/dataunit/DataUnit.ts:1879
+src/dataunit/DataUnit.ts:1935
 
 ## Methods
 
-### isAllRecords
+### isAllRecords()
 
-▸ **isAllRecords**(): `boolean`
+> **isAllRecords**(): `boolean`
 
 #### Returns
 
 `boolean`
 
-#### Defined in
+#### Source
 
-src/dataunit/DataUnit.ts:1903
+src/dataunit/DataUnit.ts:1959
 
-___
+***
 
-### isEmpty
+### isEmpty()
 
-▸ **isEmpty**(): `boolean`
+> **isEmpty**(): `boolean`
 
 #### Returns
 
 `boolean`
 
-#### Defined in
+#### Source
 
-src/dataunit/DataUnit.ts:1907
+src/dataunit/DataUnit.ts:1963

package/classes/SkwHttpProvider.md

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