@sankhyalabs/core-docs 0.0.0-feat-dev-kb-15253.0 → 0.0.0-feat-dev-KB-14960.0

package/classes/DateUtils.md

@@ -52,7 +52,7 @@ Realiza correção do horário de verão.
 
 #### Defined in
 
-src/utils/DateUtils.ts:135
+src/utils/DateUtils.ts:133
 
 ___
 
@@ -83,7 +83,7 @@ Informo: 2023-03-09 12:42:40      | Obtenho: 2023-03-09 00:00:00
 
 #### Defined in
 
-src/utils/DateUtils.ts:17
+src/utils/DateUtils.ts:15
 
 ___
 
@@ -108,7 +108,7 @@ Converte data para uma string no formato pt-BR.
 
 #### Defined in
 
-src/utils/DateUtils.ts:29
+src/utils/DateUtils.ts:27
 
 ___
 
@@ -133,7 +133,7 @@ Converte a data e hora para uma string no formato pt-BR.
 
 #### Defined in
 
-src/utils/DateUtils.ts:52
+src/utils/DateUtils.ts:50
 
 ___
 
@@ -164,7 +164,7 @@ Informo: 2023-03-09 12:42:40     | Obtenho: 2023-03-09T12:42:47-03:00
 
 #### Defined in
 
-src/utils/DateUtils.ts:185
+src/utils/DateUtils.ts:183
 
 ___
 
@@ -189,7 +189,7 @@ Converte as horas de uma data para uma string pt-BR.
 
 #### Defined in
 
-src/utils/DateUtils.ts:40
+src/utils/DateUtils.ts:38
 
 ___
 
@@ -213,7 +213,7 @@ Obtém a data atual.
 
 #### Defined in
 
-src/utils/DateUtils.ts:106
+src/utils/DateUtils.ts:104
 
 ___
 
@@ -249,7 +249,7 @@ Informo:  2     | Obtenho: "02"
 
 #### Defined in
 
-src/utils/DateUtils.ts:154
+src/utils/DateUtils.ts:152
 
 ___
 
@@ -275,7 +275,7 @@ Converte String para Date.
 
 #### Defined in
 
-src/utils/DateUtils.ts:64
+src/utils/DateUtils.ts:62
 
 ___
 
@@ -299,7 +299,7 @@ Timezone da data.
 
 #### Defined in
 
-src/utils/DateUtils.ts:164
+src/utils/DateUtils.ts:162
 
 ___
 
@@ -324,4 +324,4 @@ Retorna se a data é válida.
 
 #### Defined in
 
-src/utils/DateUtils.ts:123
+src/utils/DateUtils.ts:121

package/classes/FieldComparator.md

@@ -12,6 +12,7 @@
 
 - [compare](FieldComparator.md#compare)
 - [compareUndefined](FieldComparator.md#compareundefined)
+- [compareValues](FieldComparator.md#comparevalues)
 
 ## Constructors
 
@@ -61,4 +62,26 @@ ___
 
 #### Defined in
 
+src/dataunit/sorting/FieldComparator.ts:25
+
+___
+
+### compareValues
+
+▸ `Static` **compareValues**(`descriptor`, `valueA`, `valueB`): `number`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `descriptor` | [`FieldDescriptor`](../interfaces/FieldDescriptor.md) |
+| `valueA` | `any` |
+| `valueB` | `any` |
+
+#### Returns
+
+`number`
+
+#### Defined in
+
 src/dataunit/sorting/FieldComparator.ts:21

package/classes/IDBRepository.md

@@ -15,6 +15,10 @@ além de permitir filtros e ordenações compostas
 | :------ |
 | `T` |
 
+## Implements
+
+- [`IRepository`](../interfaces/IRepository.md)<`T`\>
+
 ## Table of contents
 
 ### Constructors
@@ -28,17 +32,23 @@ além de permitir filtros e ordenações compostas
 - [\_dbName](IDBRepository.md#_dbname)
 - [\_dbVersion](IDBRepository.md#_dbversion)
 - [\_indexKeyPath](IDBRepository.md#_indexkeypath)
+- [\_indexes](IDBRepository.md#_indexes)
+- [\_operating](IDBRepository.md#_operating)
 - [\_storeName](IDBRepository.md#_storename)
 
 ### Methods
 
 - [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)
@@ -48,7 +58,7 @@ além de permitir filtros e ordenações compostas
 
 ### constructor
 
-• **new IDBRepository**<`T`\>(`dbName`, `dbVersion`, `storeName`, `indexKeyPath`)
+• **new IDBRepository**<`T`\>(`dbName`, `dbVersion`, `storeName`, `indexKeyPath`, `indexes?`)
 
 Construtor padrão
 
@@ -66,10 +76,11 @@ Construtor padrão
 | `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)[] | - |
 
 #### Defined in
 
-src/indexeddb/IDBRepository.ts:31
+src/repository/indexeddb/IDBRepository.ts:35
 
 ## Properties
 
@@ -79,7 +90,7 @@ src/indexeddb/IDBRepository.ts:31
 
 #### Defined in
 
-src/indexeddb/IDBRepository.ts:19
+src/repository/indexeddb/IDBRepository.ts:21
 
 ___
 
@@ -89,7 +100,7 @@ ___
 
 #### Defined in
 
-src/indexeddb/IDBRepository.ts:21
+src/repository/indexeddb/IDBRepository.ts:24
 
 ___
 
@@ -99,7 +110,7 @@ ___
 
 #### Defined in
 
-src/indexeddb/IDBRepository.ts:16
+src/repository/indexeddb/IDBRepository.ts:18
 
 ___
 
@@ -109,7 +120,7 @@ ___
 
 #### Defined in
 
-src/indexeddb/IDBRepository.ts:17
+src/repository/indexeddb/IDBRepository.ts:19
 
 ___
 
@@ -119,7 +130,27 @@ ___
 
 #### Defined in
 
-src/indexeddb/IDBRepository.ts:20
+src/repository/indexeddb/IDBRepository.ts:22
+
+___
+
+### \_indexes
+
+• `Private` `Optional` **\_indexes**: [`IRepositoryIndex`](../interfaces/IRepositoryIndex.md)[]
+
+#### Defined in
+
+src/repository/indexeddb/IDBRepository.ts:23
+
+___
+
+### \_operating
+
+• `Private` **\_operating**: `boolean` = `true`
+
+#### Defined in
+
+src/repository/indexeddb/IDBRepository.ts:25
 
 ___
 
@@ -129,7 +160,7 @@ ___
 
 #### Defined in
 
-src/indexeddb/IDBRepository.ts:18
+src/repository/indexeddb/IDBRepository.ts:20
 
 ## Methods
 
@@ -145,9 +176,57 @@ Limpa todo o repositório
 
 Promessa de execução
 
+#### Implementation of
+
+[IRepository](../interfaces/IRepository.md).[clear](../interfaces/IRepository.md#clear)
+
+#### Defined in
+
+src/repository/indexeddb/IDBRepository.ts:123
+
+___
+
+### count
+
+▸ **count**(): `Promise`<`number`\>
+
+Conta os itens do repositório
+
+#### Returns
+
+`Promise`<`number`\>
+
+Promessa de quantidade
+
+#### Implementation of
+
+[IRepository](../interfaces/IRepository.md).[count](../interfaces/IRepository.md#count)
+
 #### Defined in
 
-src/indexeddb/IDBRepository.ts:113
+src/repository/indexeddb/IDBRepository.ts:236
+
+___
+
+### createStore
+
+▸ `Private` **createStore**(`db`, `name`, `indexPrefix?`): `void`
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `db` | `IDBPDatabase`<`unknown`\> | `undefined` |
+| `name` | `string` | `undefined` |
+| `indexPrefix` | `string` | `""` |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/repository/indexeddb/IDBRepository.ts:271
 
 ___
 
@@ -169,15 +248,47 @@ Remove itens do repositório
 
 Promessa de execução
 
+#### Implementation of
+
+[IRepository](../interfaces/IRepository.md).[delete](../interfaces/IRepository.md#delete)
+
 #### Defined in
 
-src/indexeddb/IDBRepository.ts:134
+src/repository/indexeddb/IDBRepository.ts:138
+
+___
+
+### distict
+
+▸ **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 |
+
+#### Returns
+
+`Promise`<`Map`<`string`, `any`\>\>
+
+Promessa de array com os valores distintos.
+
+#### Implementation of
+
+[IRepository](../interfaces/IRepository.md).[distict](../interfaces/IRepository.md#distict)
+
+#### Defined in
+
+src/repository/indexeddb/IDBRepository.ts:78
 
 ___
 
 ### getAddedItems
 
-▸ `Private` **getAddedItems**(`db`): `Promise`<`AddedItem`<`T`\>[]\>
+▸ `Private` **getAddedItems**(`db`): `Promise`<`IAddedItem`<`T`\>[]\>
 
 #### Parameters
 
@@ -187,11 +298,11 @@ ___
 
 #### Returns
 
-`Promise`<`AddedItem`<`T`\>[]\>
+`Promise`<`IAddedItem`<`T`\>[]\>
 
 #### Defined in
 
-src/indexeddb/IDBRepository.ts:303
+src/repository/indexeddb/IDBRepository.ts:319
 
 ___
 
@@ -212,7 +323,7 @@ ___
 
 #### Defined in
 
-src/indexeddb/IDBRepository.ts:268
+src/repository/indexeddb/IDBRepository.ts:284
 
 ___
 
@@ -233,7 +344,7 @@ ___
 
 #### Defined in
 
-src/indexeddb/IDBRepository.ts:291
+src/repository/indexeddb/IDBRepository.ts:307
 
 ___
 
@@ -256,9 +367,13 @@ Insere itens em uma posição de referência
 
 Promessa de execução
 
+#### Implementation of
+
+[IRepository](../interfaces/IRepository.md).[insert](../interfaces/IRepository.md#insert)
+
 #### Defined in
 
-src/indexeddb/IDBRepository.ts:203
+src/repository/indexeddb/IDBRepository.ts:194
 
 ___
 
@@ -272,9 +387,34 @@ Determina se o repositório está vazio ou ainda não foi criado.
 
 `Promise`<`boolean`\>
 
+#### Implementation of
+
+[IRepository](../interfaces/IRepository.md).[isEmpty](../interfaces/IRepository.md#isempty)
+
+#### Defined in
+
+src/repository/indexeddb/IDBRepository.ts:218
+
+___
+
+### isOperating
+
+▸ **isOperating**(): `boolean`
+
+Determina se o repositório está em condições normais de funcionamento.
+Caso o banco tenha sido excluido, retorna false.
+
+#### Returns
+
+`boolean`
+
+#### Implementation of
+
+[IRepository](../interfaces/IRepository.md).[isOperating](../interfaces/IRepository.md#isoperating)
+
 #### Defined in
 
-src/indexeddb/IDBRepository.ts:226
+src/repository/indexeddb/IDBRepository.ts:214
 
 ___
 
@@ -299,9 +439,13 @@ Recupera registros do repositório
 
 Promessa de um array que satisfaça aos critérios informados
 
+#### Implementation of
+
+[IRepository](../interfaces/IRepository.md).[load](../interfaces/IRepository.md#load)
+
 #### Defined in
 
-src/indexeddb/IDBRepository.ts:48
+src/repository/indexeddb/IDBRepository.ts:44
 
 ___
 
@@ -315,7 +459,7 @@ ___
 
 #### Defined in
 
-src/indexeddb/IDBRepository.ts:244
+src/repository/indexeddb/IDBRepository.ts:250
 
 ___
 
@@ -337,9 +481,13 @@ Adiciona registros no final do repositório
 
 Promessa de execução
 
+#### Implementation of
+
+[IRepository](../interfaces/IRepository.md).[push](../interfaces/IRepository.md#push)
+
 #### Defined in
 
-src/indexeddb/IDBRepository.ts:88
+src/repository/indexeddb/IDBRepository.ts:103
 
 ___
 
@@ -361,6 +509,10 @@ Altera itens já persistido no repositório
 
 Promessa de execução
 
+#### Implementation of
+
+[IRepository](../interfaces/IRepository.md).[update](../interfaces/IRepository.md#update)
+
 #### Defined in
 
-src/indexeddb/IDBRepository.ts:167
+src/repository/indexeddb/IDBRepository.ts:165

package/classes/IDBRepositoryHouseKeeper.md

@@ -0,0 +1,69 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / IDBRepositoryHouseKeeper
+
+# Class: IDBRepositoryHouseKeeper
+
+## Table of contents
+
+### Constructors
+
+- [constructor](IDBRepositoryHouseKeeper.md#constructor)
+
+### Properties
+
+- [\_cleaners](IDBRepositoryHouseKeeper.md#_cleaners)
+
+### Methods
+
+- [cleanUp](IDBRepositoryHouseKeeper.md#cleanup)
+- [registryCleaner](IDBRepositoryHouseKeeper.md#registrycleaner)
+
+## Constructors
+
+### constructor
+
+• **new IDBRepositoryHouseKeeper**()
+
+## Properties
+
+### \_cleaners
+
+▪ `Static` `Private` **\_cleaners**: `Map`<`String`, [`IDBRepositoryCleaner`](../interfaces/IDBRepositoryCleaner.md)\>
+
+#### Defined in
+
+src/repository/indexeddb/IDBRepositoryHouseKeeper.ts:6
+
+## Methods
+
+### cleanUp
+
+▸ `Static` **cleanUp**(): `Promise`<`void`\>
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+src/repository/indexeddb/IDBRepositoryHouseKeeper.ts:13
+
+___
+
+### registryCleaner
+
+▸ `Static` **registryCleaner**(`owner`, `cleaner`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `owner` | `string` |
+| `cleaner` | [`IDBRepositoryCleaner`](../interfaces/IDBRepositoryCleaner.md) |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/repository/indexeddb/IDBRepositoryHouseKeeper.ts:8

package/classes/SelectionInfo.md

@@ -45,7 +45,7 @@
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1822
+src/dataunit/DataUnit.ts:1834
 
 ## Properties
 
@@ -55,7 +55,7 @@ src/dataunit/DataUnit.ts:1822
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1816
+src/dataunit/DataUnit.ts:1828
 
 ___
 
@@ -65,7 +65,7 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1818
+src/dataunit/DataUnit.ts:1830
 
 ___
 
@@ -75,7 +75,7 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1819
+src/dataunit/DataUnit.ts:1831
 
 ___
 
@@ -85,7 +85,7 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1817
+src/dataunit/DataUnit.ts:1829
 
 ___
 
@@ -95,7 +95,7 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1820
+src/dataunit/DataUnit.ts:1832
 
 ## Accessors
 
@@ -109,7 +109,7 @@ src/dataunit/DataUnit.ts:1820
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1847
+src/dataunit/DataUnit.ts:1859
 
 ___
 
@@ -123,7 +123,7 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1837
+src/dataunit/DataUnit.ts:1849
 
 ___
 
@@ -137,7 +137,7 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1830
+src/dataunit/DataUnit.ts:1842
 
 ## Methods
 
@@ -151,7 +151,7 @@ src/dataunit/DataUnit.ts:1830
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1854
+src/dataunit/DataUnit.ts:1866
 
 ___
 
@@ -165,4 +165,4 @@ ___
 
 #### Defined in
 
-src/dataunit/DataUnit.ts:1858
+src/dataunit/DataUnit.ts:1870

package/classes/SkwHttpProvider.md

@@ -35,7 +35,7 @@
 
 #### Defined in
 
-src/http/SkwHttpProvider.ts:11
+src/http/SkwHttpProvider.ts:8
 
 ___
 
@@ -45,7 +45,7 @@ ___
 
 #### Defined in
 
-src/http/SkwHttpProvider.ts:7
+src/http/SkwHttpProvider.ts:4
 
 ___
 
@@ -55,7 +55,7 @@ ___
 
 #### Defined in
 
-src/http/SkwHttpProvider.ts:9
+src/http/SkwHttpProvider.ts:6
 
 ___
 
@@ -65,7 +65,7 @@ ___
 
 #### Defined in
 
-src/http/SkwHttpProvider.ts:8
+src/http/SkwHttpProvider.ts:5
 
 ___
 
@@ -75,7 +75,7 @@ ___
 
 #### Defined in
 
-src/http/SkwHttpProvider.ts:10
+src/http/SkwHttpProvider.ts:7
 
 ___
 
@@ -85,7 +85,7 @@ ___
 
 #### Defined in
 
-src/http/SkwHttpProvider.ts:5
+src/http/SkwHttpProvider.ts:2
 
 ## Methods
 
@@ -106,4 +106,4 @@ src/http/SkwHttpProvider.ts:5
 
 #### Defined in
 
-src/http/SkwHttpProvider.ts:13
+src/http/SkwHttpProvider.ts:10