@sankhyalabs/core-docs 5.20.0-rc.2 → 5.20.0-rc.21

package/classes/IDBRepository.md

@@ -279,6 +279,28 @@ src/repository/indexeddb/IDBRepository.ts:319
 
 ***
 
+### 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
+
+#### 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`\>

package/classes/MaskFormatter.md

@@ -129,7 +129,7 @@ src/utils/MaskFormatter.ts:55
 
 #### Source
 
-src/utils/MaskFormatter.ts:375
+src/utils/MaskFormatter.ts:379
 
 ***
 
@@ -149,7 +149,7 @@ src/utils/MaskFormatter.ts:54
 
 #### Source
 
-src/utils/MaskFormatter.ts:389
+src/utils/MaskFormatter.ts:393
 
 ***
 
@@ -179,7 +179,7 @@ src/utils/MaskFormatter.ts:49
 
 #### Source
 
-src/utils/MaskFormatter.ts:300
+src/utils/MaskFormatter.ts:304
 
 ***
 
@@ -209,7 +209,7 @@ src/utils/MaskFormatter.ts:52
 
 #### Source
 
-src/utils/MaskFormatter.ts:281
+src/utils/MaskFormatter.ts:285
 
 ***
 
@@ -219,7 +219,7 @@ src/utils/MaskFormatter.ts:281
 
 #### Source
 
-src/utils/MaskFormatter.ts:352
+src/utils/MaskFormatter.ts:356
 
 ***
 
@@ -239,7 +239,7 @@ src/utils/MaskFormatter.ts:51
 
 #### Source
 
-src/utils/MaskFormatter.ts:329
+src/utils/MaskFormatter.ts:333
 
 ## Accessors
 
@@ -271,7 +271,7 @@ src/utils/MaskFormatter.ts:87
 
 ### format()
 
-> **format**(`value`): `string`
+> **format**(`value`, `trimBefore`): `string`
 
 Formata a string passada baseada na máscara definda pelo atributo mask.
 
@@ -281,6 +281,10 @@ Formata a string passada baseada na máscara definda pelo atributo mask.
 
 Valor a ser formatado.
 
+• **trimBefore**: `boolean`= `false`
+
+Executa um trim para remover espaços em branco.
+
 #### Returns
 
 `string`
@@ -289,7 +293,7 @@ O valor processado de acordo com o padrão.
 
 #### Source
 
-src/utils/MaskFormatter.ts:101
+src/utils/MaskFormatter.ts:102
 
 ***
 
@@ -305,4 +309,4 @@ Prepara a formatação internamente de acordo com o padrão.
 
 #### Source
 
-src/utils/MaskFormatter.ts:118
+src/utils/MaskFormatter.ts:122

package/classes/ObjectUtils.md

@@ -76,6 +76,147 @@ src/utils/ObjectUtils.ts:84
 
 ***
 
+### getComparableProp()
+
+> `static` `private` **getComparableProp**(`value`, `propToCompare`): `boolean`
+
+#### Parameters
+
+• **value**: `any`
+
+• **propToCompare**: `string`= `"value"`
+
+#### Returns
+
+`boolean`
+
+#### Source
+
+src/utils/ObjectUtils.ts:106
+
+***
+
+### getProp()
+
+> `static` **getProp**(`obj`, `keyPath`): `undefined` \| `Record`\<`string`, `any`\>
+
+Busca a propriedade de um objeto baseado em seu caminho.
+
+#### Parameters
+
+• **obj**: `Record`\<`string`, `any`\>
+
+Objeto a ser verificado.
+
+• **keyPath**: `string`
+
+Caminho da propriedade a ser buscada.
+
+#### Returns
+
+`undefined` \| `Record`\<`string`, `any`\>
+
+- O valor da propriedade caso ela exista.
+
+#### Source
+
+src/utils/ObjectUtils.ts:140
+
+***
+
+### hasEquivalentProps()
+
+> `static` **hasEquivalentProps**(`obj1`, `obj2`, `propToCompare`): `boolean`
+
+Compara se o valor de dois items são equivalentes.
+Comparando tanto o valor do item em si, quanto sua propriedade "value"
+
+#### Parameters
+
+• **obj1**: `any`
+
+Objeto a ser comparado.
+
+• **obj2**: `any`
+
+Objeto a ser comparado.
+
+• **propToCompare**: `string`= `"value"`
+
+propriedade que deve ser comparada.
+
+#### Returns
+
+`boolean`
+
+- Se o objeto 1 é equivalente ao objeto 2.
+
+*
+
+#### Examples
+
+```ts
+hasEquivalentProps('123', {value: '123', label: teste}, 'value') | Retorna: true
+```
+
+```ts
+hasEquivalentProps('xpto', {value: '123', label: teste}, 'propName') | Retorna: false
+```
+
+#### Source
+
+src/utils/ObjectUtils.ts:102
+
+***
+
+### isEmpty()
+
+> `static` **isEmpty**(`obj`): `boolean`
+
+Verifica se o objeto está vazio (sem atributos).
+
+#### Parameters
+
+• **obj**: `object`
+
+Objeto a ser verificado.
+
+#### Returns
+
+`boolean`
+
+- True caso o objeto esteja vazio.
+
+#### Source
+
+src/utils/ObjectUtils.ts:119
+
+***
+
+### isNotEmpty()
+
+> `static` **isNotEmpty**(`obj`): `boolean`
+
+Verifica se o objeto NÃO está vazio (sem atributos).
+
+#### Parameters
+
+• **obj**: `object`
+
+Objeto a ser verificado.
+
+#### Returns
+
+`boolean`
+
+- True caso o objeto NÃO esteja vazio
+
+#### Source
+
+src/utils/ObjectUtils.ts:129
+
+***
+
 ### objectToString()
 
 > `static` **objectToString**(`data`): `string`

package/classes/SelectionInfo.md

@@ -30,7 +30,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1914
+src/dataunit/DataUnit.ts:1971
 
 ## Properties
 
@@ -40,7 +40,7 @@ src/dataunit/DataUnit.ts:1914
 
 #### Source
 
-src/dataunit/DataUnit.ts:1908
+src/dataunit/DataUnit.ts:1968
 
 ***
 
@@ -50,7 +50,7 @@ src/dataunit/DataUnit.ts:1908
 
 #### Source
 
-src/dataunit/DataUnit.ts:1910
+src/dataunit/DataUnit.ts:1969
 
 ***
 
@@ -60,7 +60,21 @@ src/dataunit/DataUnit.ts:1910
 
 #### Source
 
-src/dataunit/DataUnit.ts:1911
+src/dataunit/DataUnit.ts:1965
+
+***
+
+### getAllRecords()?
+
+> `optional` **getAllRecords**: () => `undefined` \| [`Record`](../interfaces/Record.md)[]
+
+#### Returns
+
+`undefined` \| [`Record`](../interfaces/Record.md)[]
+
+#### Source
+
+src/dataunit/DataUnit.ts:1967
 
 ***
 
@@ -70,7 +84,7 @@ src/dataunit/DataUnit.ts:1911
 
 #### Source
 
-src/dataunit/DataUnit.ts:1909
+src/dataunit/DataUnit.ts:1964
 
 ***
 
@@ -80,7 +94,7 @@ src/dataunit/DataUnit.ts:1909
 
 #### Source
 
-src/dataunit/DataUnit.ts:1912
+src/dataunit/DataUnit.ts:1966
 
 ## Accessors
 
@@ -94,7 +108,7 @@ src/dataunit/DataUnit.ts:1912
 
 #### Source
 
-src/dataunit/DataUnit.ts:1939
+src/dataunit/DataUnit.ts:1999
 
 ***
 
@@ -108,7 +122,7 @@ src/dataunit/DataUnit.ts:1939
 
 #### Source
 
-src/dataunit/DataUnit.ts:1929
+src/dataunit/DataUnit.ts:1989
 
 ***
 
@@ -122,7 +136,7 @@ src/dataunit/DataUnit.ts:1929
 
 #### Source
 
-src/dataunit/DataUnit.ts:1922
+src/dataunit/DataUnit.ts:1979
 
 ## Methods
 
@@ -136,7 +150,7 @@ src/dataunit/DataUnit.ts:1922
 
 #### Source
 
-src/dataunit/DataUnit.ts:1946
+src/dataunit/DataUnit.ts:2006
 
 ***
 
@@ -150,4 +164,4 @@ src/dataunit/DataUnit.ts:1946
 
 #### Source
 
-src/dataunit/DataUnit.ts:1950
+src/dataunit/DataUnit.ts:2010

package/enumerations/Action.md

@@ -14,7 +14,7 @@
 
 #### Source
 
-src/dataunit/state/action/DataUnitAction.ts:52
+src/dataunit/state/action/DataUnitAction.ts:53
 
 ***
 
@@ -24,7 +24,7 @@ src/dataunit/state/action/DataUnitAction.ts:52
 
 #### Source
 
-src/dataunit/state/action/DataUnitAction.ts:51
+src/dataunit/state/action/DataUnitAction.ts:52
 
 ***
 
@@ -34,7 +34,7 @@ src/dataunit/state/action/DataUnitAction.ts:51
 
 #### Source
 
-src/dataunit/state/action/DataUnitAction.ts:45
+src/dataunit/state/action/DataUnitAction.ts:46
 
 ***
 
@@ -44,7 +44,7 @@ src/dataunit/state/action/DataUnitAction.ts:45
 
 #### Source
 
-src/dataunit/state/action/DataUnitAction.ts:63
+src/dataunit/state/action/DataUnitAction.ts:64
 
 ***
 
@@ -54,7 +54,7 @@ src/dataunit/state/action/DataUnitAction.ts:63
 
 #### Source
 
-src/dataunit/state/action/DataUnitAction.ts:47
+src/dataunit/state/action/DataUnitAction.ts:48
 
 ***
 
@@ -74,7 +74,7 @@ src/dataunit/state/action/DataUnitAction.ts:33
 
 #### Source
 
-src/dataunit/state/action/DataUnitAction.ts:48
+src/dataunit/state/action/DataUnitAction.ts:49
 
 ***
 
@@ -94,7 +94,7 @@ src/dataunit/state/action/DataUnitAction.ts:37
 
 #### Source
 
-src/dataunit/state/action/DataUnitAction.ts:50
+src/dataunit/state/action/DataUnitAction.ts:51
 
 ***
 
@@ -104,7 +104,7 @@ src/dataunit/state/action/DataUnitAction.ts:50
 
 #### Source
 
-src/dataunit/state/action/DataUnitAction.ts:65
+src/dataunit/state/action/DataUnitAction.ts:66
 
 ***
 
@@ -114,7 +114,7 @@ src/dataunit/state/action/DataUnitAction.ts:65
 
 #### Source
 
-src/dataunit/state/action/DataUnitAction.ts:66
+src/dataunit/state/action/DataUnitAction.ts:67
 
 ***
 
@@ -144,7 +144,7 @@ src/dataunit/state/action/DataUnitAction.ts:29
 
 #### Source
 
-src/dataunit/state/action/DataUnitAction.ts:69
+src/dataunit/state/action/DataUnitAction.ts:70
 
 ***
 
@@ -154,7 +154,7 @@ src/dataunit/state/action/DataUnitAction.ts:69
 
 #### Source
 
-src/dataunit/state/action/DataUnitAction.ts:68
+src/dataunit/state/action/DataUnitAction.ts:69
 
 ***
 
@@ -164,7 +164,7 @@ src/dataunit/state/action/DataUnitAction.ts:68
 
 #### Source
 
-src/dataunit/state/action/DataUnitAction.ts:60
+src/dataunit/state/action/DataUnitAction.ts:61
 
 ***
 
@@ -184,7 +184,7 @@ src/dataunit/state/action/DataUnitAction.ts:30
 
 #### Source
 
-src/dataunit/state/action/DataUnitAction.ts:55
+src/dataunit/state/action/DataUnitAction.ts:56
 
 ***
 
@@ -204,7 +204,7 @@ src/dataunit/state/action/DataUnitAction.ts:34
 
 #### Source
 
-src/dataunit/state/action/DataUnitAction.ts:56
+src/dataunit/state/action/DataUnitAction.ts:57
 
 ***
 
@@ -214,7 +214,7 @@ src/dataunit/state/action/DataUnitAction.ts:56
 
 #### Source
 
-src/dataunit/state/action/DataUnitAction.ts:42
+src/dataunit/state/action/DataUnitAction.ts:43
 
 ***
 
@@ -224,7 +224,7 @@ src/dataunit/state/action/DataUnitAction.ts:42
 
 #### Source
 
-src/dataunit/state/action/DataUnitAction.ts:43
+src/dataunit/state/action/DataUnitAction.ts:44
 
 ***
 
@@ -234,7 +234,7 @@ src/dataunit/state/action/DataUnitAction.ts:43
 
 #### Source
 
-src/dataunit/state/action/DataUnitAction.ts:40
+src/dataunit/state/action/DataUnitAction.ts:41
 
 ***
 
@@ -244,7 +244,7 @@ src/dataunit/state/action/DataUnitAction.ts:40
 
 #### Source
 
-src/dataunit/state/action/DataUnitAction.ts:61
+src/dataunit/state/action/DataUnitAction.ts:62
 
 ***
 
@@ -254,7 +254,7 @@ src/dataunit/state/action/DataUnitAction.ts:61
 
 #### Source
 
-src/dataunit/state/action/DataUnitAction.ts:39
+src/dataunit/state/action/DataUnitAction.ts:40
 
 ***
 
@@ -268,13 +268,23 @@ src/dataunit/state/action/DataUnitAction.ts:36
 
 ***
 
+### SAVING\_ERROR
+
+> **SAVING\_ERROR**: `"savingError"`
+
+#### Source
+
+src/dataunit/state/action/DataUnitAction.ts:38
+
+***
+
 ### SELECTION\_CHANGED
 
 > **SELECTION\_CHANGED**: `"selectionChanged"`
 
 #### Source
 
-src/dataunit/state/action/DataUnitAction.ts:54
+src/dataunit/state/action/DataUnitAction.ts:55
 
 ***
 
@@ -284,7 +294,7 @@ src/dataunit/state/action/DataUnitAction.ts:54
 
 #### Source
 
-src/dataunit/state/action/DataUnitAction.ts:58
+src/dataunit/state/action/DataUnitAction.ts:59
 
 ***
 
@@ -294,4 +304,4 @@ src/dataunit/state/action/DataUnitAction.ts:58
 
 #### Source
 
-src/dataunit/state/action/DataUnitAction.ts:46
+src/dataunit/state/action/DataUnitAction.ts:47

package/enumerations/ChangeOperation.md

@@ -14,7 +14,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1794
+src/dataunit/DataUnit.ts:1850
 
 ***
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1794
 
 #### Source
 
-src/dataunit/DataUnit.ts:1796
+src/dataunit/DataUnit.ts:1852
 
 ***
 
@@ -34,7 +34,7 @@ src/dataunit/DataUnit.ts:1796
 
 #### Source
 
-src/dataunit/DataUnit.ts:1793
+src/dataunit/DataUnit.ts:1849
 
 ***
 
@@ -44,4 +44,4 @@ src/dataunit/DataUnit.ts:1793
 
 #### Source
 
-src/dataunit/DataUnit.ts:1795
+src/dataunit/DataUnit.ts:1851

package/enumerations/SelectionMode.md

@@ -14,7 +14,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1902
+src/dataunit/DataUnit.ts:1958
 
 ***
 
@@ -24,4 +24,4 @@ src/dataunit/DataUnit.ts:1902
 
 #### Source
 
-src/dataunit/DataUnit.ts:1903
+src/dataunit/DataUnit.ts:1959

package/globals.md

@@ -85,6 +85,7 @@
 
 ## Type Aliases
 
+- [DataUnitEventOptions](type-aliases/DataUnitEventOptions.md)
 - [OnOverflowCallBack](type-aliases/OnOverflowCallBack.md)
 
 ## Variables

package/interfaces/DUActionInterceptor.md

@@ -22,4 +22,4 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1777
+src/dataunit/DataUnit.ts:1833

package/interfaces/IRepository.md

@@ -96,6 +96,24 @@ 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
+
+src/repository/IRepository.ts:88
+
+***
+
 ### insert()
 
 > **insert**(`itemReference`, `items`): `Promise`\<`void`\>

package/interfaces/LoadDataRequest.md

@@ -96,7 +96,7 @@ src/dataunit/loading/LoadDataRequest.ts:22
 
 ### source?
 
-> `optional` **source**: `String`
+> `optional` **source**: `string`
 
 De onde partiu o refresh. Por padrão a fonte não é identificada
 

package/interfaces/PageRequest.md

@@ -14,7 +14,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1882
+src/dataunit/DataUnit.ts:1938
 
 ***
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1882
 
 #### Source
 
-src/dataunit/DataUnit.ts:1883
+src/dataunit/DataUnit.ts:1939
 
 ***
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1883
 
 #### Source
 
-src/dataunit/DataUnit.ts:1884
+src/dataunit/DataUnit.ts:1940