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

package/classes/IDBRepository.md

@@ -1,6 +1,10 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / IDBRepository
+[**@sankhyalabs/core**](../README.md) • **Docs**
 
-# Class: IDBRepository<T\>
+***
+
+[@sankhyalabs/core](../globals.md) / IDBRepository
+
+# Class: IDBRepository\<T\>
 
 Abstração para simplificar o uso do indexed DB
 
@@ -11,74 +15,45 @@ além de permitir filtros e ordenações compostas
 
 ## Type parameters
 
-| Name |
-| :------ |
-| `T` |
+• **T**
 
 ## Implements
 
-- [`IRepository`](../interfaces/IRepository.md)<`T`\>
+- [`IRepository`](../interfaces/IRepository.md)\<`T`\>
 
-## Table of contents
+## Constructors
 
-### Constructors
+### new IDBRepository()
 
-- [constructor](IDBRepository.md#constructor)
+> **new IDBRepository**\<`T`\>(`dbName`, `dbVersion`, `storeName`, `indexKeyPath`, `indexes`?): [`IDBRepository`](IDBRepository.md)\<`T`\>
 
-### Properties
+Construtor padrão
 
-- [\_addedStoreName](IDBRepository.md#_addedstorename)
-- [\_db](IDBRepository.md#_db)
-- [\_dbName](IDBRepository.md#_dbname)
-- [\_dbVersion](IDBRepository.md#_dbversion)
-- [\_indexKeyPath](IDBRepository.md#_indexkeypath)
-- [\_indexes](IDBRepository.md#_indexes)
-- [\_operating](IDBRepository.md#_operating)
-- [\_storeName](IDBRepository.md#_storename)
+#### Parameters
 
-### Methods
+• **dbName**: `string`
 
-- [clear](IDBRepository.md#clear)
-- [count](IDBRepository.md#count)
-- [createStore](IDBRepository.md#createstore)
-- [delete](IDBRepository.md#delete)
-- [distict](IDBRepository.md#distict)
-- [getAddedItems](IDBRepository.md#getaddeditems)
-- [getItemPosition](IDBRepository.md#getitemposition)
-- [getItemPositionByAdded](IDBRepository.md#getitempositionbyadded)
-- [insert](IDBRepository.md#insert)
-- [isEmpty](IDBRepository.md#isempty)
-- [isOperating](IDBRepository.md#isoperating)
-- [load](IDBRepository.md#load)
-- [openDB](IDBRepository.md#opendb)
-- [push](IDBRepository.md#push)
-- [update](IDBRepository.md#update)
+Nome do DB
 
-## Constructors
+• **dbVersion**: `number`
 
-### constructor
+Versão do DB
 
-• **new IDBRepository**<`T`\>(`dbName`, `dbVersion`, `storeName`, `indexKeyPath`, `indexes?`)
+• **storeName**: `string`
 
-Construtor padrão
+Nome da store
 
-#### Type parameters
+• **indexKeyPath**: `string`
 
-| Name |
-| :------ |
-| `T` |
+Um atributo que identifique os objetos guardados
 
-#### Parameters
+• **indexes?**: [`IRepositoryIndex`](../interfaces/IRepositoryIndex.md)[]
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `dbName` | `string` | Nome do DB |
-| `dbVersion` | `number` | Versão do DB |
-| `storeName` | `string` | Nome da store |
-| `indexKeyPath` | `string` | Um atributo que identifique os objetos guardados |
-| `indexes?` | [`IRepositoryIndex`](../interfaces/IRepositoryIndex.md)[] | - |
+#### Returns
 
-#### Defined in
+[`IDBRepository`](IDBRepository.md)\<`T`\>
+
+#### Source
 
 src/repository/indexeddb/IDBRepository.ts:35
 
@@ -86,320 +61,341 @@ src/repository/indexeddb/IDBRepository.ts:35
 
 ### \_addedStoreName
 
-• `Private` **\_addedStoreName**: `string`
+> `private` **\_addedStoreName**: `string`
 
-#### Defined in
+#### Source
 
 src/repository/indexeddb/IDBRepository.ts:21
 
-___
+***
 
-### \_db
+### \_db?
 
-• `Private` `Optional` **\_db**: `IDBPDatabase`<`unknown`\>
+> `private` `optional` **\_db**: `IDBPDatabase`\<`unknown`\>
 
-#### Defined in
+#### Source
 
 src/repository/indexeddb/IDBRepository.ts:24
 
-___
+***
 
 ### \_dbName
 
-• `Private` **\_dbName**: `string`
+> `private` **\_dbName**: `string`
 
-#### Defined in
+#### Source
 
 src/repository/indexeddb/IDBRepository.ts:18
 
-___
+***
 
 ### \_dbVersion
 
-• `Private` **\_dbVersion**: `number`
+> `private` **\_dbVersion**: `number`
 
-#### Defined in
+#### Source
 
 src/repository/indexeddb/IDBRepository.ts:19
 
-___
+***
 
 ### \_indexKeyPath
 
-• `Private` **\_indexKeyPath**: `string`
+> `private` **\_indexKeyPath**: `string`
 
-#### Defined in
+#### Source
 
 src/repository/indexeddb/IDBRepository.ts:22
 
-___
+***
 
-### \_indexes
+### \_indexes?
 
-• `Private` `Optional` **\_indexes**: [`IRepositoryIndex`](../interfaces/IRepositoryIndex.md)[]
+> `private` `optional` **\_indexes**: [`IRepositoryIndex`](../interfaces/IRepositoryIndex.md)[]
 
-#### Defined in
+#### Source
 
 src/repository/indexeddb/IDBRepository.ts:23
 
-___
+***
 
 ### \_operating
 
-• `Private` **\_operating**: `boolean` = `true`
+> `private` **\_operating**: `boolean` = `true`
 
-#### Defined in
+#### Source
 
 src/repository/indexeddb/IDBRepository.ts:25
 
-___
+***
 
 ### \_storeName
 
-• `Private` **\_storeName**: `string`
+> `private` **\_storeName**: `string`
 
-#### Defined in
+#### Source
 
 src/repository/indexeddb/IDBRepository.ts:20
 
 ## Methods
 
-### clear
+### clear()
 
-▸ **clear**(): `Promise`<`void`\>
+> **clear**(): `Promise`\<`void`\>
 
 Limpa todo o repositório
 
 #### Returns
 
-`Promise`<`void`\>
+`Promise`\<`void`\>
 
 Promessa de execução
 
 #### Implementation of
 
-[IRepository](../interfaces/IRepository.md).[clear](../interfaces/IRepository.md#clear)
+[`IRepository`](../interfaces/IRepository.md).[`clear`](../interfaces/IRepository.md#clear)
 
-#### Defined in
+#### Source
 
 src/repository/indexeddb/IDBRepository.ts:123
 
-___
+***
 
-### count
+### count()
 
-▸ **count**(): `Promise`<`number`\>
+> **count**(): `Promise`\<`number`\>
 
 Conta os itens do repositório
 
 #### Returns
 
-`Promise`<`number`\>
+`Promise`\<`number`\>
 
 Promessa de quantidade
 
 #### Implementation of
 
-[IRepository](../interfaces/IRepository.md).[count](../interfaces/IRepository.md#count)
+[`IRepository`](../interfaces/IRepository.md).[`count`](../interfaces/IRepository.md#count)
 
-#### Defined in
+#### Source
 
 src/repository/indexeddb/IDBRepository.ts:236
 
-___
+***
 
-### createStore
+### createStore()
 
-▸ `Private` **createStore**(`db`, `name`, `indexPrefix?`): `void`
+> `private` **createStore**(`db`, `name`, `indexPrefix`): `void`
 
 #### Parameters
 
-| Name | Type | Default value |
-| :------ | :------ | :------ |
-| `db` | `IDBPDatabase`<`unknown`\> | `undefined` |
-| `name` | `string` | `undefined` |
-| `indexPrefix` | `string` | `""` |
+• **db**: `IDBPDatabase`\<`unknown`\>
+
+• **name**: `string`
+
+• **indexPrefix**: `string`= `""`
 
 #### Returns
 
 `void`
 
-#### Defined in
+#### Source
 
 src/repository/indexeddb/IDBRepository.ts:271
 
-___
+***
 
-### 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
 
 #### Implementation of
 
-[IRepository](../interfaces/IRepository.md).[delete](../interfaces/IRepository.md#delete)
+[`IRepository`](../interfaces/IRepository.md).[`delete`](../interfaces/IRepository.md#delete)
 
-#### Defined in
+#### Source
 
 src/repository/indexeddb/IDBRepository.ts:138
 
-___
+***
 
-### 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.
 
 #### Implementation of
 
-[IRepository](../interfaces/IRepository.md).[distict](../interfaces/IRepository.md#distict)
+[`IRepository`](../interfaces/IRepository.md).[`distict`](../interfaces/IRepository.md#distict)
 
-#### Defined in
+#### Source
 
 src/repository/indexeddb/IDBRepository.ts:78
 
-___
+***
 
-### getAddedItems
+### getAddedItems()
 
-▸ `Private` **getAddedItems**(`db`): `Promise`<`IAddedItem`<`T`\>[]\>
+> `private` **getAddedItems**(`db`): `Promise`\<`IAddedItem`\<`T`\>[]\>
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `db` | `IDBPDatabase`<`unknown`\> |
+• **db**: `IDBPDatabase`\<`unknown`\>
 
 #### Returns
 
-`Promise`<`IAddedItem`<`T`\>[]\>
+`Promise`\<`IAddedItem`\<`T`\>[]\>
 
-#### Defined in
+#### Source
 
 src/repository/indexeddb/IDBRepository.ts:319
 
-___
+***
+
+### getFromCache()
+
+> **getFromCache**(): `undefined` \| `T`[]
 
-### getItemPosition
+Retorna todos os registros que estão em cache no momento
 
-▸ `Private` **getItemPosition**(`db`, `itemTest`): `Promise`<`number`\>
+#### Returns
+
+`undefined` \| `T`[]
+
+Todos registros que estão em cache no momento
+
+#### Implementation of
+
+[`IRepository`](../interfaces/IRepository.md).[`getFromCache`](../interfaces/IRepository.md#getfromcache)
+
+#### Source
+
+src/repository/indexeddb/IDBRepository.ts:324
+
+***
+
+### getItemPosition()
+
+> `private` **getItemPosition**(`db`, `itemTest`): `Promise`\<`number`\>
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `db` | `IDBPDatabase`<`unknown`\> |
-| `itemTest` | (`item`: `any`) => `boolean` |
+• **db**: `IDBPDatabase`\<`unknown`\>
+
+• **itemTest**
 
 #### Returns
 
-`Promise`<`number`\>
+`Promise`\<`number`\>
 
-#### Defined in
+#### Source
 
 src/repository/indexeddb/IDBRepository.ts:284
 
-___
+***
 
-### getItemPositionByAdded
+### getItemPositionByAdded()
 
-▸ `Private` **getItemPositionByAdded**(`db`, `itemTest`): `Promise`<`number`\>
+> `private` **getItemPositionByAdded**(`db`, `itemTest`): `Promise`\<`number`\>
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `db` | `IDBPDatabase`<`unknown`\> |
-| `itemTest` | (`item`: `any`) => `boolean` |
+• **db**: `IDBPDatabase`\<`unknown`\>
+
+• **itemTest**
 
 #### Returns
 
-`Promise`<`number`\>
+`Promise`\<`number`\>
 
-#### Defined in
+#### Source
 
 src/repository/indexeddb/IDBRepository.ts:307
 
-___
+***
 
-### insert
+### insert()
 
-▸ **insert**(`itemReference`, `items`): `Promise`<`void`\>
+> **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
 
 #### Implementation of
 
-[IRepository](../interfaces/IRepository.md).[insert](../interfaces/IRepository.md#insert)
+[`IRepository`](../interfaces/IRepository.md).[`insert`](../interfaces/IRepository.md#insert)
 
-#### Defined in
+#### Source
 
 src/repository/indexeddb/IDBRepository.ts:194
 
-___
+***
 
-### 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`\>
 
 #### Implementation of
 
-[IRepository](../interfaces/IRepository.md).[isEmpty](../interfaces/IRepository.md#isempty)
+[`IRepository`](../interfaces/IRepository.md).[`isEmpty`](../interfaces/IRepository.md#isempty)
 
-#### Defined in
+#### Source
 
 src/repository/indexeddb/IDBRepository.ts:218
 
-___
+***
 
-### 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.
@@ -410,109 +406,118 @@ Caso o banco tenha sido excluido, retorna false.
 
 #### Implementation of
 
-[IRepository](../interfaces/IRepository.md).[isOperating](../interfaces/IRepository.md#isoperating)
+[`IRepository`](../interfaces/IRepository.md).[`isOperating`](../interfaces/IRepository.md#isoperating)
 
-#### Defined in
+#### Source
 
 src/repository/indexeddb/IDBRepository.ts:214
 
-___
+***
 
-### load
+### load()
 
-▸ **load**(`filterFunction?`, `sortingFunction?`, `offset?`, `limit?`): `Promise`<[`ILoadResult`](../interfaces/ILoadResult.md)<`T`\>\>
+> **load**(`filterFunction`?, `sortingFunction`?, `offset`?, `limit`?): `Promise`\<[`ILoadResult`](../interfaces/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`](../interfaces/ILoadResult.md)<`T`\>\>
+`Promise`\<[`ILoadResult`](../interfaces/ILoadResult.md)\<`T`\>\>
 
 Promessa de um array que satisfaça aos critérios informados
 
 #### Implementation of
 
-[IRepository](../interfaces/IRepository.md).[load](../interfaces/IRepository.md#load)
+[`IRepository`](../interfaces/IRepository.md).[`load`](../interfaces/IRepository.md#load)
 
-#### Defined in
+#### Source
 
 src/repository/indexeddb/IDBRepository.ts:44
 
-___
+***
 
-### openDB
+### openDB()
 
-▸ `Private` **openDB**(): `Promise`<`IDBPDatabase`<`unknown`\>\>
+> `private` **openDB**(): `Promise`\<`IDBPDatabase`\<`unknown`\>\>
 
 #### Returns
 
-`Promise`<`IDBPDatabase`<`unknown`\>\>
+`Promise`\<`IDBPDatabase`\<`unknown`\>\>
 
-#### Defined in
+#### Source
 
 src/repository/indexeddb/IDBRepository.ts:250
 
-___
+***
 
-### 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
 
 #### Implementation of
 
-[IRepository](../interfaces/IRepository.md).[push](../interfaces/IRepository.md#push)
+[`IRepository`](../interfaces/IRepository.md).[`push`](../interfaces/IRepository.md#push)
 
-#### Defined in
+#### Source
 
 src/repository/indexeddb/IDBRepository.ts:103
 
-___
+***
 
-### 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
 
 #### Implementation of
 
-[IRepository](../interfaces/IRepository.md).[update](../interfaces/IRepository.md#update)
+[`IRepository`](../interfaces/IRepository.md).[`update`](../interfaces/IRepository.md#update)
 
-#### Defined in
+#### Source
 
 src/repository/indexeddb/IDBRepository.ts:165