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

package/interfaces/IRepositoryIndex.md

@@ -1,66 +1,59 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / IRepositoryIndex
+[**@sankhyalabs/core**](../README.md) • **Docs**
 
-# Interface: IRepositoryIndex
-
-## Hierarchy
-
-- `IDBIndexParameters`
+***
 
-  ↳ **`IRepositoryIndex`**
+[@sankhyalabs/core](../globals.md) / IRepositoryIndex
 
-## Table of contents
+# Interface: IRepositoryIndex
 
-### Properties
+## Extends
 
-- [multiEntry](IRepositoryIndex.md#multientry)
-- [name](IRepositoryIndex.md#name)
-- [path](IRepositoryIndex.md#path)
-- [unique](IRepositoryIndex.md#unique)
+- `IDBIndexParameters`
 
 ## Properties
 
-### multiEntry
+### multiEntry?
 
-• `Optional` **multiEntry**: `boolean`
+> `optional` **multiEntry**: `boolean`
 
 #### Inherited from
 
-IDBIndexParameters.multiEntry
+`IDBIndexParameters.multiEntry`
 
-#### Defined in
+#### Source
 
-node_modules/typescript/lib/lib.dom.d.ts:583
+node\_modules/typescript/lib/lib.dom.d.ts:583
 
-___
+***
 
 ### name
 
-• **name**: `string`
+> **name**: `string`
 
-#### Defined in
+#### Source
 
 src/repository/indexeddb/IRepositoryIndex.ts:2
 
-___
+***
 
 ### path
 
-• **path**: `string`
+> **path**: `string`
 
-#### Defined in
+#### Source
 
 src/repository/indexeddb/IRepositoryIndex.ts:3
 
-___
+***
 
-### unique
+### unique?
 
-• `Optional` **unique**: `boolean`
+> `optional` **unique**: `boolean`
 
 #### Inherited from
 
-IDBIndexParameters.unique
+`IDBIndexParameters.unique`
 
-#### Defined in
+#### Source
 
-node_modules/typescript/lib/lib.dom.d.ts:584
+node\_modules/typescript/lib/lib.dom.d.ts:584

package/interfaces/LoadDataRequest.md

@@ -1,114 +1,105 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / LoadDataRequest
+[**@sankhyalabs/core**](../README.md) • **Docs**
 
-# Interface: LoadDataRequest
-
-Atributos enviados na requisição de carregamento dos registros
+***
 
-## Table of contents
+[@sankhyalabs/core](../globals.md) / LoadDataRequest
 
-### Properties
+# Interface: LoadDataRequest
 
-- [filters](LoadDataRequest.md#filters)
-- [keepSelection](LoadDataRequest.md#keepselection)
-- [limit](LoadDataRequest.md#limit)
-- [offset](LoadDataRequest.md#offset)
-- [parentRecordId](LoadDataRequest.md#parentrecordid)
-- [quickFilter](LoadDataRequest.md#quickfilter)
-- [sort](LoadDataRequest.md#sort)
-- [source](LoadDataRequest.md#source)
+Atributos enviados na requisição de carregamento dos registros
 
 ## Properties
 
-### filters
+### filters?
 
-• `Optional` **filters**: [`Filter`](Filter.md)[]
+> `optional` **filters**: [`Filter`](Filter.md)[]
 
 Filtros
 
-#### Defined in
+#### Source
 
 src/dataunit/loading/LoadDataRequest.ts:19
 
-___
+***
 
-### keepSelection
+### keepSelection?
 
-• `Optional` **keepSelection**: `boolean`
+> `optional` **keepSelection**: `boolean`
 
 Na navegação de páginas devemos manter a seleção
 
-#### Defined in
+#### Source
 
 src/dataunit/loading/LoadDataRequest.ts:28
 
-___
+***
 
-### limit
+### limit?
 
-• `Optional` **limit**: `number`
+> `optional` **limit**: `number`
 
 Quantidade de registros que será retornado
 
-#### Defined in
+#### Source
 
 src/dataunit/loading/LoadDataRequest.ts:13
 
-___
+***
 
-### offset
+### offset?
 
-• `Optional` **offset**: `number`
+> `optional` **offset**: `number`
 
 Indice inicial dos registros que será retornado
 
-#### Defined in
+#### Source
 
 src/dataunit/loading/LoadDataRequest.ts:10
 
-___
+***
 
-### parentRecordId
+### parentRecordId?
 
-• `Optional` **parentRecordId**: `string`
+> `optional` **parentRecordId**: `string`
 
 Info parent
 
-#### Defined in
+#### Source
 
 src/dataunit/loading/LoadDataRequest.ts:25
 
-___
+***
 
-### quickFilter
+### quickFilter?
 
-• `Optional` **quickFilter**: [`QuickFilter`](QuickFilter.md)
+> `optional` **quickFilter**: [`QuickFilter`](QuickFilter.md)
 
 Filtro rápido
 
-#### Defined in
+#### Source
 
 src/dataunit/loading/LoadDataRequest.ts:16
 
-___
+***
 
-### sort
+### sort?
 
-• `Optional` **sort**: [`Sort`](Sort.md)[]
+> `optional` **sort**: [`Sort`](Sort.md)[]
 
 Ordenação dos resultados
 
-#### Defined in
+#### Source
 
 src/dataunit/loading/LoadDataRequest.ts:22
 
-___
+***
 
-### source
+### source?
 
-• `Optional` **source**: `String`
+> `optional` **source**: `String`
 
 De onde partiu o refresh. Por padrão a fonte não é identificada
 
-#### Defined in
+#### Source
 
 src/dataunit/loading/LoadDataRequest.ts:7

package/interfaces/LoadDataResponse.md

@@ -1,36 +1,33 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / LoadDataResponse
+[**@sankhyalabs/core**](../README.md) • **Docs**
 
-# Interface: LoadDataResponse
-
-Retorno dos registros da requisição de carregamento de dados
+***
 
-## Table of contents
+[@sankhyalabs/core](../globals.md) / LoadDataResponse
 
-### Properties
+# Interface: LoadDataResponse
 
-- [paginationInfo](LoadDataResponse.md#paginationinfo)
-- [records](LoadDataResponse.md#records)
+Retorno dos registros da requisição de carregamento de dados
 
 ## Properties
 
-### paginationInfo
+### paginationInfo?
 
-• `Optional` **paginationInfo**: [`PaginationInfo`](PaginationInfo.md)
+> `optional` **paginationInfo**: [`PaginationInfo`](PaginationInfo.md)
 
 Informações da paginação
 
-#### Defined in
+#### Source
 
 src/dataunit/loading/LoadDataResponse.ts:10
 
-___
+***
 
 ### records
 
-• **records**: [`Record`](Record.md)[]
+> **records**: [`Record`](Record.md)[]
 
 Registros retornados na requisição
 
-#### Defined in
+#### Source
 
 src/dataunit/loading/LoadDataResponse.ts:7

package/interfaces/PageRequest.md

@@ -1,41 +1,37 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / PageRequest
+[**@sankhyalabs/core**](../README.md) • **Docs**
 
-# Interface: PageRequest
-
-## Table of contents
+***
 
-### Properties
+[@sankhyalabs/core](../globals.md) / PageRequest
 
-- [limit](PageRequest.md#limit)
-- [offset](PageRequest.md#offset)
-- [quickFilter](PageRequest.md#quickfilter)
+# Interface: PageRequest
 
 ## Properties
 
 ### limit
 
-• **limit**: `number`
+> **limit**: `number`
 
-#### Defined in
+#### Source
 
-src/dataunit/DataUnit.ts:1848
+src/dataunit/DataUnit.ts:1883
 
-___
+***
 
 ### offset
 
-• **offset**: `number`
+> **offset**: `number`
 
-#### Defined in
+#### Source
 
-src/dataunit/DataUnit.ts:1849
+src/dataunit/DataUnit.ts:1884
 
-___
+***
 
-### quickFilter
+### quickFilter?
 
-• `Optional` **quickFilter**: [`QuickFilter`](QuickFilter.md)
+> `optional` **quickFilter**: [`QuickFilter`](QuickFilter.md)
 
-#### Defined in
+#### Source
 
-src/dataunit/DataUnit.ts:1850
+src/dataunit/DataUnit.ts:1885

package/interfaces/PaginationInfo.md

@@ -1,88 +1,81 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / PaginationInfo
+[**@sankhyalabs/core**](../README.md) • **Docs**
 
-# Interface: PaginationInfo
-
-Informações da paginação retornada na requisição de carregamento de registros
+***
 
-## Table of contents
+[@sankhyalabs/core](../globals.md) / PaginationInfo
 
-### Properties
+# Interface: PaginationInfo
 
-- [count](PaginationInfo.md#count)
-- [currentPage](PaginationInfo.md#currentpage)
-- [firstRecord](PaginationInfo.md#firstrecord)
-- [hasMore](PaginationInfo.md#hasmore)
-- [lastRecord](PaginationInfo.md#lastrecord)
-- [total](PaginationInfo.md#total)
+Informações da paginação retornada na requisição de carregamento de registros
 
 ## Properties
 
-### count
+### count?
 
-• `Optional` **count**: `number`
+> `optional` **count**: `number`
 
 Quantidade de registros carregados até o momento
 
-#### Defined in
+#### Source
 
 src/dataunit/loading/PaginationInfo.ts:17
 
-___
+***
 
 ### currentPage
 
-• **currentPage**: `number`
+> **currentPage**: `number`
 
 Página atual
 
-#### Defined in
+#### Source
 
 src/dataunit/loading/PaginationInfo.ts:5
 
-___
+***
 
 ### firstRecord
 
-• **firstRecord**: `number`
+> **firstRecord**: `number`
 
 Indice do primeiro registro na página
 
-#### Defined in
+#### Source
 
 src/dataunit/loading/PaginationInfo.ts:8
 
-___
+***
 
 ### hasMore
 
-• **hasMore**: `boolean`
+> **hasMore**: `boolean`
 
 Se ainda existem mais registros
 
-#### Defined in
+#### Source
 
 src/dataunit/loading/PaginationInfo.ts:20
 
-___
+***
 
 ### lastRecord
 
-• **lastRecord**: `number`
+> **lastRecord**: `number`
 
 Indice do último registro na página
 
-#### Defined in
+#### Source
 
 src/dataunit/loading/PaginationInfo.ts:11
 
-___
+***
 
-### total
+### total?
 
-• `Optional` **total**: `number`
+> `optional` **total**: `number`
 
 Quantidade total de registros
 
-#### Defined in
+#### Source
 
 src/dataunit/loading/PaginationInfo.ts:14

package/interfaces/PromiseSyncCallback.md

@@ -1,39 +1,35 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / PromiseSyncCallback
+[**@sankhyalabs/core**](../README.md) • **Docs**
 
-# Interface: PromiseSyncCallback<T\>
+***
 
-Representa o callback de um sincronizador `PromiseSync<T>`.
-
-## Type parameters
+[@sankhyalabs/core](../globals.md) / PromiseSyncCallback
 
-| Name |
-| :------ |
-| `T` |
+# Interface: PromiseSyncCallback\<T\>
 
-## Table of contents
+Representa o callback de um sincronizador `PromiseSync<T>`.
 
-### Methods
+## Type parameters
 
-- [resolve](PromiseSyncCallback.md#resolve)
+• **T**
 
 ## Methods
 
-### resolve
+### resolve()
 
-▸ **resolve**(`result`): `void`
+> **resolve**(`result`): `void`
 
 Será chamado sempre que todas as promessas adicionadas finalizarem.
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `result` | `PromiseSettledResult`<`Awaited`<`T`\>\>[] | A lista com o resultado de todas as promises aguardadas. |
+• **result**: `PromiseSettledResult`\<`Awaited`\<`T`\>\>[]
+
+A lista com o resultado de todas as promises aguardadas.
 
 #### Returns
 
 `void`
 
-#### Defined in
+#### Source
 
 src/async/PromiseSync.ts:48

package/interfaces/QuickFilter.md

@@ -1,41 +1,37 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / QuickFilter
+[**@sankhyalabs/core**](../README.md) • **Docs**
 
-# Interface: QuickFilter
-
-## Table of contents
+***
 
-### Properties
+[@sankhyalabs/core](../globals.md) / QuickFilter
 
-- [fields](QuickFilter.md#fields)
-- [filter](QuickFilter.md#filter)
-- [term](QuickFilter.md#term)
+# Interface: QuickFilter
 
 ## Properties
 
-### fields
+### fields?
 
-• `Optional` **fields**: `string`[]
+> `optional` **fields**: `string`[]
 
-#### Defined in
+#### Source
 
-src/dataunit/DataUnit.ts:1855
+src/dataunit/DataUnit.ts:1890
 
-___
+***
 
-### filter
+### filter?
 
-• `Optional` **filter**: [`Filter`](Filter.md)
+> `optional` **filter**: [`Filter`](Filter.md)
 
-#### Defined in
+#### Source
 
-src/dataunit/DataUnit.ts:1856
+src/dataunit/DataUnit.ts:1891
 
-___
+***
 
 ### term
 
-• **term**: `string`
+> **term**: `string`
 
-#### Defined in
+#### Source
 
-src/dataunit/DataUnit.ts:1854
+src/dataunit/DataUnit.ts:1889

package/interfaces/Record.md

@@ -1,62 +1,55 @@
-[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / Record
+[**@sankhyalabs/core**](../README.md) • **Docs**
 
-# Interface: Record
-
-## Hierarchy
-
-- **`Record`**
+***
 
-  ↳ [`SavedRecord`](SavedRecord.md)
+[@sankhyalabs/core](../globals.md) / Record
 
-## Indexable
+# Interface: Record
 
-▪ [key: `string`]: `any`
+## Extended by
 
-## Table of contents
+- [`SavedRecord`](SavedRecord.md)
 
-### Properties
+## Indexable
 
-- [\_\_owner\_\_dataunit\_\_name\_\_](Record.md#__owner__dataunit__name__)
-- [\_\_parent\_\_record\_\_id\_\_](Record.md#__parent__record__id__)
-- [\_\_record\_\_id\_\_](Record.md#__record__id__)
-- [\_\_record\_\_label\_\_](Record.md#__record__label__)
+ \[`key`: `string`\]: `any`
 
 ## Properties
 
-### \_\_owner\_\_dataunit\_\_name\_\_
+### \_\_owner\_\_dataunit\_\_name\_\_?
 
-• `Optional` **\_\_owner\_\_dataunit\_\_name\_\_**: `string`
+> `optional` **\_\_owner\_\_dataunit\_\_name\_\_**: `string`
 
-#### Defined in
+#### Source
 
-src/dataunit/DataUnit.ts:1750
+src/dataunit/DataUnit.ts:1785
 
-___
+***
 
-### \_\_parent\_\_record\_\_id\_\_
+### \_\_parent\_\_record\_\_id\_\_?
 
-• `Optional` **\_\_parent\_\_record\_\_id\_\_**: `string`
+> `optional` **\_\_parent\_\_record\_\_id\_\_**: `string`
 
-#### Defined in
+#### Source
 
-src/dataunit/DataUnit.ts:1749
+src/dataunit/DataUnit.ts:1784
 
-___
+***
 
 ### \_\_record\_\_id\_\_
 
-• **\_\_record\_\_id\_\_**: `string`
+> **\_\_record\_\_id\_\_**: `string`
 
-#### Defined in
+#### Source
 
-src/dataunit/DataUnit.ts:1747
+src/dataunit/DataUnit.ts:1782
 
-___
+***
 
-### \_\_record\_\_label\_\_
+### \_\_record\_\_label\_\_?
 
-• `Optional` **\_\_record\_\_label\_\_**: `string`
+> `optional` **\_\_record\_\_label\_\_**: `string`
 
-#### Defined in
+#### Source
 
-src/dataunit/DataUnit.ts:1748
+src/dataunit/DataUnit.ts:1783