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

package/interfaces/FieldDescriptor.md

@@ -1,151 +1,137 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / FieldDescriptor
+[**@sankhyalabs/core**](../README.md) • **Docs**
 
-# Interface: FieldDescriptor
-
-## Table of contents
+***
 
-### Properties
+[@sankhyalabs/core](../globals.md) / FieldDescriptor
 
-- [dataType](FieldDescriptor.md#datatype)
-- [defaultValue](FieldDescriptor.md#defaultvalue)
-- [dependencies](FieldDescriptor.md#dependencies)
-- [group](FieldDescriptor.md#group)
-- [label](FieldDescriptor.md#label)
-- [name](FieldDescriptor.md#name)
-- [order](FieldDescriptor.md#order)
-- [properties](FieldDescriptor.md#properties)
-- [readOnly](FieldDescriptor.md#readonly)
-- [required](FieldDescriptor.md#required)
-- [standAlone](FieldDescriptor.md#standalone)
-- [userInterface](FieldDescriptor.md#userinterface)
-- [visible](FieldDescriptor.md#visible)
+# Interface: FieldDescriptor
 
 ## Properties
 
 ### dataType
 
-• **dataType**: [`DataType`](../enums/DataType.md)
+> **dataType**: [`DataType`](../enumerations/DataType.md)
 
-#### Defined in
+#### Source
 
 src/dataunit/metadata/UnitMetadata.ts:24
 
-___
+***
 
-### defaultValue
+### defaultValue?
 
-• `Optional` **defaultValue**: `any`
+> `optional` **defaultValue**: `any`
 
-#### Defined in
+#### Source
 
 src/dataunit/metadata/UnitMetadata.ts:26
 
-___
+***
 
-### dependencies
+### dependencies?
 
-• `Optional` **dependencies**: `FieldDependency`[]
+> `optional` **dependencies**: `FieldDependency`[]
 
-#### Defined in
+#### Source
 
 src/dataunit/metadata/UnitMetadata.ts:32
 
-___
+***
 
-### group
+### group?
 
-• `Optional` **group**: `string`
+> `optional` **group**: `string`
 
-#### Defined in
+#### Source
 
 src/dataunit/metadata/UnitMetadata.ts:33
 
-___
+***
 
 ### label
 
-• **label**: `string`
+> **label**: `string`
 
-#### Defined in
+#### Source
 
 src/dataunit/metadata/UnitMetadata.ts:23
 
-___
+***
 
 ### name
 
-• **name**: `string`
+> **name**: `string`
 
-#### Defined in
+#### Source
 
 src/dataunit/metadata/UnitMetadata.ts:22
 
-___
+***
 
-### order
+### order?
 
-• `Optional` **order**: `number`
+> `optional` **order**: `number`
 
-#### Defined in
+#### Source
 
 src/dataunit/metadata/UnitMetadata.ts:34
 
-___
+***
 
-### properties
+### properties?
 
-• `Optional` **properties**: `any`
+> `optional` **properties**: `any`
 
-#### Defined in
+#### Source
 
 src/dataunit/metadata/UnitMetadata.ts:31
 
-___
+***
 
-### readOnly
+### readOnly?
 
-• `Optional` **readOnly**: `boolean`
+> `optional` **readOnly**: `boolean`
 
-#### Defined in
+#### Source
 
 src/dataunit/metadata/UnitMetadata.ts:28
 
-___
+***
 
-### required
+### required?
 
-• `Optional` **required**: `boolean`
+> `optional` **required**: `boolean`
 
-#### Defined in
+#### Source
 
 src/dataunit/metadata/UnitMetadata.ts:29
 
-___
+***
 
-### standAlone
+### standAlone?
 
-• `Optional` **standAlone**: `boolean`
+> `optional` **standAlone**: `boolean`
 
-#### Defined in
+#### Source
 
 src/dataunit/metadata/UnitMetadata.ts:30
 
-___
+***
 
-### userInterface
+### userInterface?
 
-• `Optional` **userInterface**: [`UserInterface`](../enums/UserInterface.md)
+> `optional` **userInterface**: [`UserInterface`](../enumerations/UserInterface.md)
 
-#### Defined in
+#### Source
 
 src/dataunit/metadata/UnitMetadata.ts:25
 
-___
+***
 
-### visible
+### visible?
 
-• `Optional` **visible**: `boolean`
+> `optional` **visible**: `boolean`
 
-#### Defined in
+#### Source
 
 src/dataunit/metadata/UnitMetadata.ts:27

package/interfaces/Filter.md

@@ -1,41 +1,37 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / Filter
+[**@sankhyalabs/core**](../README.md) • **Docs**
 
-# Interface: Filter
-
-## Table of contents
+***
 
-### Properties
+[@sankhyalabs/core](../globals.md) / Filter
 
-- [expression](Filter.md#expression)
-- [name](Filter.md#name)
-- [params](Filter.md#params)
+# Interface: Filter
 
 ## Properties
 
 ### expression
 
-• **expression**: `string`
+> **expression**: `string`
 
-#### Defined in
+#### Source
 
 src/dataunit/metadata/UnitMetadata.ts:45
 
-___
+***
 
 ### name
 
-• **name**: `string`
+> **name**: `string`
 
-#### Defined in
+#### Source
 
 src/dataunit/metadata/UnitMetadata.ts:44
 
-___
+***
 
-### params
+### params?
 
-• `Optional` **params**: `FilterParam`[]
+> `optional` **params**: `FilterParam`[]
 
-#### Defined in
+#### Source
 
 src/dataunit/metadata/UnitMetadata.ts:46

package/interfaces/IElementIDInfo.md

@@ -1,30 +1,27 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / IElementIDInfo
+[**@sankhyalabs/core**](../README.md) • **Docs**
 
-# Interface: IElementIDInfo
-
-## Table of contents
+***
 
-### Properties
+[@sankhyalabs/core](../globals.md) / IElementIDInfo
 
-- [dataUnit](IElementIDInfo.md#dataunit)
-- [id](IElementIDInfo.md#id)
+# Interface: IElementIDInfo
 
 ## Properties
 
-### dataUnit
+### dataUnit?
 
-• `Optional` **dataUnit**: [`DataUnit`](../classes/DataUnit.md)
+> `optional` **dataUnit**: [`DataUnit`](../classes/DataUnit.md)
 
-#### Defined in
+#### Source
 
 src/utils/ElementIDUtils.ts:7
 
-___
+***
 
-### id
+### id?
 
-• `Optional` **id**: `string`
+> `optional` **id**: `string`
 
-#### Defined in
+#### Source
 
 src/utils/ElementIDUtils.ts:6

package/interfaces/ILoadResult.md

@@ -1,36 +1,31 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / ILoadResult
+[**@sankhyalabs/core**](../README.md) • **Docs**
 
-# Interface: ILoadResult<T\>
+***
 
-## Type parameters
-
-| Name |
-| :------ |
-| `T` |
+[@sankhyalabs/core](../globals.md) / ILoadResult
 
-## Table of contents
+# Interface: ILoadResult\<T\>
 
-### Properties
+## Type parameters
 
-- [count](ILoadResult.md#count)
-- [result](ILoadResult.md#result)
+• **T**
 
 ## Properties
 
 ### count
 
-• **count**: `number`
+> **count**: `number`
 
-#### Defined in
+#### Source
 
 src/repository/ILoadResult.ts:3
 
-___
+***
 
 ### result
 
-• **result**: `T`[]
+> **result**: `T`[]
 
-#### Defined in
+#### Source
 
 src/repository/ILoadResult.ts:2

package/interfaces/IRepository.md

@@ -1,162 +1,166 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / IRepository
+[**@sankhyalabs/core**](../README.md) • **Docs**
 
-# Interface: IRepository<T\>
+***
 
-## Type parameters
-
-| Name |
-| :------ |
-| `T` |
-
-## Implemented by
-
-- [`IDBRepository`](../classes/IDBRepository.md)
+[@sankhyalabs/core](../globals.md) / IRepository
 
-## Table of contents
+# Interface: IRepository\<T\>
 
-### Methods
+## Type parameters
 
-- [clear](IRepository.md#clear)
-- [count](IRepository.md#count)
-- [delete](IRepository.md#delete)
-- [distict](IRepository.md#distict)
-- [insert](IRepository.md#insert)
-- [isEmpty](IRepository.md#isempty)
-- [isOperating](IRepository.md#isoperating)
-- [load](IRepository.md#load)
-- [push](IRepository.md#push)
-- [update](IRepository.md#update)
+• **T**
 
 ## Methods
 
-### clear
+### clear()
 
-▸ **clear**(): `Promise`<`void`\>
+> **clear**(): `Promise`\<`void`\>
 
 Limpa todo o repositório
 
 #### Returns
 
-`Promise`<`void`\>
+`Promise`\<`void`\>
 
 Promessa de execução
 
-#### Defined in
+#### Source
 
 src/repository/IRepository.ts:38
 
-___
+***
 
-### count
+### count()
 
-▸ **count**(): `Promise`<`number`\>
+> **count**(): `Promise`\<`number`\>
 
 Conta os itens do repositório
 
 #### Returns
 
-`Promise`<`number`\>
+`Promise`\<`number`\>
 
 Promessa de quantidade
 
-#### Defined in
+#### Source
 
 src/repository/IRepository.ts:81
 
-___
+***
 
-### delete
+### delete()
 
-▸ **delete**(`items`): `Promise`<`void`\>
+> **delete**(`items`): `Promise`\<`void`\>
 
 Remove itens do repositório
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `items` | `T`[] | Os itens a serem removidos |
+• **items**: `T`[]
+
+Os itens a serem removidos
 
 #### Returns
 
-`Promise`<`void`\>
+`Promise`\<`void`\>
 
 Promessa de execução
 
-#### Defined in
+#### Source
 
 src/repository/IRepository.ts:46
 
-___
+***
 
-### distict
+### distict()
 
-▸ **distict**(`itemProcessor`): `Promise`<`Map`<`string`, `any`\>\>
+> **distict**(`itemProcessor`): `Promise`\<`Map`\<`string`, `any`\>\>
 
 Itera todos os items colecionando os valores distintos.
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `itemProcessor` | (`item`: `T`) => { `key`: `string` ; `value`: `any`  } | Uma função que processa um item e gera a chave e valor |
+• **itemProcessor**
+
+Uma função que processa um item e gera a chave e valor
 
 #### Returns
 
-`Promise`<`Map`<`string`, `any`\>\>
+`Promise`\<`Map`\<`string`, `any`\>\>
 
 Promessa de array com os valores distintos.
 
-#### Defined in
+#### Source
 
 src/repository/IRepository.ts:23
 
-___
+***
+
+### getFromCache()
+
+> **getFromCache**(): `undefined` \| `T`[]
+
+Retorna todos os registros que estão em cache no momento
+
+#### Returns
+
+`undefined` \| `T`[]
+
+Todos registros que estão em cache no momento
+
+#### Source
 
-### insert
+src/repository/IRepository.ts:88
 
-▸ **insert**(`itemReference`, `items`): `Promise`<`void`\>
+***
+
+### insert()
+
+> **insert**(`itemReference`, `items`): `Promise`\<`void`\>
 
 Insere itens em uma posição de referência
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `itemReference` | `T` | O item posterior aos inseridos |
-| `items` | `T`[] | Os itens a serem inseridos |
+• **itemReference**: `T`
+
+O item posterior aos inseridos
+
+• **items**: `T`[]
+
+Os itens a serem inseridos
 
 #### Returns
 
-`Promise`<`void`\>
+`Promise`\<`void`\>
 
 Promessa de execução
 
-#### Defined in
+#### Source
 
 src/repository/IRepository.ts:63
 
-___
+***
 
-### isEmpty
+### isEmpty()
 
-▸ **isEmpty**(): `Promise`<`boolean`\>
+> **isEmpty**(): `Promise`\<`boolean`\>
 
 Determina se o repositório está vazio ou ainda não foi criado.
 
 #### Returns
 
-`Promise`<`boolean`\>
+`Promise`\<`boolean`\>
 
-#### Defined in
+#### Source
 
 src/repository/IRepository.ts:74
 
-___
+***
 
-### isOperating
+### isOperating()
 
-▸ **isOperating**(): `boolean`
+> **isOperating**(): `boolean`
 
 Determina se o repositório está em condições normais de funcionamento.
 Caso o banco tenha sido excluido, retorna false.
@@ -165,81 +169,90 @@ Caso o banco tenha sido excluido, retorna false.
 
 `boolean`
 
-#### Defined in
+#### Source
 
 src/repository/IRepository.ts:69
 
-___
+***
 
-### load
+### load()
 
-▸ **load**(`filterFunction?`, `sortingFunction?`, `offset?`, `limit?`): `Promise`<[`ILoadResult`](ILoadResult.md)<`T`\>\>
+> **load**(`filterFunction`?, `sortingFunction`?, `offset`?, `limit`?): `Promise`\<[`ILoadResult`](ILoadResult.md)\<`T`\>\>
 
 Recupera registros do repositório
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `filterFunction?` | (`value`: `T`) => `boolean` | Teste para determinar se um registro está no universo desejado |
-| `sortingFunction?` | (`itemA`: `T`, `itemB`: `T`) => `number` | Critério comparação para ordenação |
-| `offset?` | `number` | Determina que o resultado descarta os registros iniciais |
-| `limit?` | `number` | Descarta o resultado a partir de uma quantidade de registros |
+• **filterFunction?**
+
+Teste para determinar se um registro está no universo desejado
+
+• **sortingFunction?**
+
+Critério comparação para ordenação
+
+• **offset?**: `number`
+
+Determina que o resultado descarta os registros iniciais
+
+• **limit?**: `number`
+
+Descarta o resultado a partir de uma quantidade de registros
 
 #### Returns
 
-`Promise`<[`ILoadResult`](ILoadResult.md)<`T`\>\>
+`Promise`\<[`ILoadResult`](ILoadResult.md)\<`T`\>\>
 
 Promessa de um array que satisfaça aos critérios informados
 
-#### Defined in
+#### Source
 
 src/repository/IRepository.ts:14
 
-___
+***
 
-### push
+### push()
 
-▸ **push**(`items`): `Promise`<`void`\>
+> **push**(`items`): `Promise`\<`void`\>
 
 Adiciona registros no final do repositório
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `items` | `T`[] | Os items a serem adicionados |
+• **items**: `T`[]
+
+Os items a serem adicionados
 
 #### Returns
 
-`Promise`<`void`\>
+`Promise`\<`void`\>
 
 Promessa de execução
 
-#### Defined in
+#### Source
 
 src/repository/IRepository.ts:31
 
-___
+***
 
-### update
+### update()
 
-▸ **update**(`items`): `Promise`<`void`\>
+> **update**(`items`): `Promise`\<`void`\>
 
 Altera itens já persistido no repositório
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `items` | `T`[] | Os itens a serem alterados |
+• **items**: `T`[]
+
+Os itens a serem alterados
 
 #### Returns
 
-`Promise`<`void`\>
+`Promise`\<`void`\>
 
 Promessa de execução
 
-#### Defined in
+#### Source
 
 src/repository/IRepository.ts:54