@sankhyalabs/core-docs 5.10.1 → 5.11.0-dev.2

package/classes/DateUtils.md

@@ -52,7 +52,7 @@ Realiza correção do horário de verão.
 
 #### Defined in
 
-src/utils/DateUtils.ts:138
+src/utils/DateUtils.ts:136
 
 ___
 
@@ -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:55
+src/utils/DateUtils.ts:53
 
 ___
 
@@ -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:188
+src/utils/DateUtils.ts:186
 
 ___
 
@@ -189,7 +189,7 @@ Converte as horas de uma data para uma string pt-BR.
 
 #### Defined in
 
-src/utils/DateUtils.ts:43
+src/utils/DateUtils.ts:41
 
 ___
 
@@ -213,7 +213,7 @@ Obtém a data atual.
 
 #### Defined in
 
-src/utils/DateUtils.ts:109
+src/utils/DateUtils.ts:107
 
 ___
 
@@ -249,7 +249,7 @@ Informo:  2     | Obtenho: "02"
 
 #### Defined in
 
-src/utils/DateUtils.ts:157
+src/utils/DateUtils.ts:155
 
 ___
 
@@ -275,7 +275,7 @@ Converte String para Date.
 
 #### Defined in
 
-src/utils/DateUtils.ts:67
+src/utils/DateUtils.ts:65
 
 ___
 
@@ -299,7 +299,7 @@ Timezone da data.
 
 #### Defined in
 
-src/utils/DateUtils.ts:167
+src/utils/DateUtils.ts:165
 
 ___
 
@@ -324,4 +324,4 @@ Retorna se a data é válida.
 
 #### Defined in
 
-src/utils/DateUtils.ts:126
+src/utils/DateUtils.ts:124

package/classes/FieldComparator.md

@@ -0,0 +1,87 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / FieldComparator
+
+# Class: FieldComparator
+
+## Table of contents
+
+### Constructors
+
+- [constructor](FieldComparator.md#constructor)
+
+### Methods
+
+- [compare](FieldComparator.md#compare)
+- [compareUndefined](FieldComparator.md#compareundefined)
+- [compareValues](FieldComparator.md#comparevalues)
+
+## Constructors
+
+### constructor
+
+• **new FieldComparator**()
+
+## Methods
+
+### compare
+
+▸ `Static` **compare**(`field`, `recordA`, `recordB`, `asc?`): `number`
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `field` | [`FieldDescriptor`](../interfaces/FieldDescriptor.md) | `undefined` |
+| `recordA` | [`Record`](../interfaces/Record.md) | `undefined` |
+| `recordB` | [`Record`](../interfaces/Record.md) | `undefined` |
+| `asc` | `boolean` | `true` |
+
+#### Returns
+
+`number`
+
+#### Defined in
+
+src/dataunit/sorting/FieldComparator.ts:7
+
+___
+
+### compareUndefined
+
+▸ `Static` **compareUndefined**(`isUndefinedA`, `isUndefinedB`): `undefined` \| `number`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `isUndefinedA` | `boolean` |
+| `isUndefinedB` | `boolean` |
+
+#### Returns
+
+`undefined` \| `number`
+
+#### Defined in
+
+src/dataunit/sorting/FieldComparator.ts:26
+
+___
+
+### 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:16

package/classes/IDBRepository.md

@@ -0,0 +1,518 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / IDBRepository
+
+# Class: IDBRepository<T\>
+
+Abstração para simplificar o uso do indexed DB
+
+Além de facilitar os comandos de incluir, remover alterar e obter
+objetos, esse repositório preserva a ordem de inserção na lista, 
+além de permitir filtros e ordenações compostas 
+(impossíveis com uso de índices).
+
+## Type parameters
+
+| Name |
+| :------ |
+| `T` |
+
+## Implements
+
+- [`IRepository`](../interfaces/IRepository.md)<`T`\>
+
+## Table of contents
+
+### Constructors
+
+- [constructor](IDBRepository.md#constructor)
+
+### Properties
+
+- [\_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)
+
+### 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)
+- [update](IDBRepository.md#update)
+
+## Constructors
+
+### constructor
+
+• **new IDBRepository**<`T`\>(`dbName`, `dbVersion`, `storeName`, `indexKeyPath`, `indexes?`)
+
+Construtor padrão
+
+#### Type parameters
+
+| Name |
+| :------ |
+| `T` |
+
+#### Parameters
+
+| 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)[] | - |
+
+#### Defined in
+
+src/repository/indexeddb/IDBRepository.ts:35
+
+## Properties
+
+### \_addedStoreName
+
+• `Private` **\_addedStoreName**: `string`
+
+#### Defined in
+
+src/repository/indexeddb/IDBRepository.ts:21
+
+___
+
+### \_db
+
+• `Private` `Optional` **\_db**: `IDBPDatabase`<`unknown`\>
+
+#### Defined in
+
+src/repository/indexeddb/IDBRepository.ts:24
+
+___
+
+### \_dbName
+
+• `Private` **\_dbName**: `string`
+
+#### Defined in
+
+src/repository/indexeddb/IDBRepository.ts:18
+
+___
+
+### \_dbVersion
+
+• `Private` **\_dbVersion**: `number`
+
+#### Defined in
+
+src/repository/indexeddb/IDBRepository.ts:19
+
+___
+
+### \_indexKeyPath
+
+• `Private` **\_indexKeyPath**: `string`
+
+#### Defined in
+
+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
+
+___
+
+### \_storeName
+
+• `Private` **\_storeName**: `string`
+
+#### Defined in
+
+src/repository/indexeddb/IDBRepository.ts:20
+
+## Methods
+
+### clear
+
+▸ **clear**(): `Promise`<`void`\>
+
+Limpa todo o repositório
+
+#### Returns
+
+`Promise`<`void`\>
+
+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/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
+
+___
+
+### delete
+
+▸ **delete**(`items`): `Promise`<`void`\>
+
+Remove itens do repositório
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `items` | `T`[] | Os itens a serem removidos |
+
+#### Returns
+
+`Promise`<`void`\>
+
+Promessa de execução
+
+#### Implementation of
+
+[IRepository](../interfaces/IRepository.md).[delete](../interfaces/IRepository.md#delete)
+
+#### Defined in
+
+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`<`IAddedItem`<`T`\>[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `db` | `IDBPDatabase`<`unknown`\> |
+
+#### Returns
+
+`Promise`<`IAddedItem`<`T`\>[]\>
+
+#### Defined in
+
+src/repository/indexeddb/IDBRepository.ts:319
+
+___
+
+### getItemPosition
+
+▸ `Private` **getItemPosition**(`db`, `itemTest`): `Promise`<`number`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `db` | `IDBPDatabase`<`unknown`\> |
+| `itemTest` | (`item`: `any`) => `boolean` |
+
+#### Returns
+
+`Promise`<`number`\>
+
+#### Defined in
+
+src/repository/indexeddb/IDBRepository.ts:284
+
+___
+
+### getItemPositionByAdded
+
+▸ `Private` **getItemPositionByAdded**(`db`, `itemTest`): `Promise`<`number`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `db` | `IDBPDatabase`<`unknown`\> |
+| `itemTest` | (`item`: `any`) => `boolean` |
+
+#### Returns
+
+`Promise`<`number`\>
+
+#### Defined in
+
+src/repository/indexeddb/IDBRepository.ts:307
+
+___
+
+### 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 |
+
+#### Returns
+
+`Promise`<`void`\>
+
+Promessa de execução
+
+#### Implementation of
+
+[IRepository](../interfaces/IRepository.md).[insert](../interfaces/IRepository.md#insert)
+
+#### Defined in
+
+src/repository/indexeddb/IDBRepository.ts:194
+
+___
+
+### isEmpty
+
+▸ **isEmpty**(): `Promise`<`boolean`\>
+
+Determina se o repositório está vazio ou ainda não foi criado.
+
+#### Returns
+
+`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/repository/indexeddb/IDBRepository.ts:214
+
+___
+
+### load
+
+▸ **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 |
+
+#### Returns
+
+`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)
+
+#### Defined in
+
+src/repository/indexeddb/IDBRepository.ts:44
+
+___
+
+### openDB
+
+▸ `Private` **openDB**(): `Promise`<`IDBPDatabase`<`unknown`\>\>
+
+#### Returns
+
+`Promise`<`IDBPDatabase`<`unknown`\>\>
+
+#### Defined in
+
+src/repository/indexeddb/IDBRepository.ts:250
+
+___
+
+### push
+
+▸ **push**(`items`): `Promise`<`void`\>
+
+Adiciona registros no final do repositório
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `items` | `T`[] | Os items a serem adicionados |
+
+#### Returns
+
+`Promise`<`void`\>
+
+Promessa de execução
+
+#### Implementation of
+
+[IRepository](../interfaces/IRepository.md).[push](../interfaces/IRepository.md#push)
+
+#### Defined in
+
+src/repository/indexeddb/IDBRepository.ts:103
+
+___
+
+### update
+
+▸ **update**(`items`): `Promise`<`void`\>
+
+Altera itens já persistido no repositório
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `items` | `T`[] | Os itens a serem alterados |
+
+#### Returns
+
+`Promise`<`void`\>
+
+Promessa de execução
+
+#### Implementation of
+
+[IRepository](../interfaces/IRepository.md).[update](../interfaces/IRepository.md#update)
+
+#### Defined in
+
+src/repository/indexeddb/IDBRepository.ts:165