@sankhyalabs/core-docs 5.20.0-rc.17 → 5.20.0-rc.19

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,99 @@ 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`
@@ -96,7 +189,7 @@ Objeto a ser verificado.
 
 #### Source
 
-src/utils/ObjectUtils.ts:94
+src/utils/ObjectUtils.ts:119
 
 ***
 
@@ -120,7 +213,7 @@ Objeto a ser verificado.
 
 #### Source
 
-src/utils/ObjectUtils.ts:104
+src/utils/ObjectUtils.ts:129
 
 ***
 

package/classes/SelectionInfo.md

@@ -30,7 +30,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1951
+src/dataunit/DataUnit.ts:1975
 
 ## Properties
 
@@ -40,7 +40,7 @@ src/dataunit/DataUnit.ts:1951
 
 #### Source
 
-src/dataunit/DataUnit.ts:1945
+src/dataunit/DataUnit.ts:1972
 
 ***
 
@@ -50,7 +50,7 @@ src/dataunit/DataUnit.ts:1945
 
 #### Source
 
-src/dataunit/DataUnit.ts:1947
+src/dataunit/DataUnit.ts:1973
 
 ***
 
@@ -60,7 +60,21 @@ src/dataunit/DataUnit.ts:1947
 
 #### Source
 
-src/dataunit/DataUnit.ts:1948
+src/dataunit/DataUnit.ts:1969
+
+***
+
+### getAllRecords()?
+
+> `optional` **getAllRecords**: () => `undefined` \| [`Record`](../interfaces/Record.md)[]
+
+#### Returns
+
+`undefined` \| [`Record`](../interfaces/Record.md)[]
+
+#### Source
+
+src/dataunit/DataUnit.ts:1971
 
 ***
 
@@ -70,7 +84,7 @@ src/dataunit/DataUnit.ts:1948
 
 #### Source
 
-src/dataunit/DataUnit.ts:1946
+src/dataunit/DataUnit.ts:1968
 
 ***
 
@@ -80,7 +94,7 @@ src/dataunit/DataUnit.ts:1946
 
 #### Source
 
-src/dataunit/DataUnit.ts:1949
+src/dataunit/DataUnit.ts:1970
 
 ## Accessors
 
@@ -94,7 +108,7 @@ src/dataunit/DataUnit.ts:1949
 
 #### Source
 
-src/dataunit/DataUnit.ts:1976
+src/dataunit/DataUnit.ts:2003
 
 ***
 
@@ -108,7 +122,7 @@ src/dataunit/DataUnit.ts:1976
 
 #### Source
 
-src/dataunit/DataUnit.ts:1966
+src/dataunit/DataUnit.ts:1993
 
 ***
 
@@ -122,7 +136,7 @@ src/dataunit/DataUnit.ts:1966
 
 #### Source
 
-src/dataunit/DataUnit.ts:1959
+src/dataunit/DataUnit.ts:1983
 
 ## Methods
 
@@ -136,7 +150,7 @@ src/dataunit/DataUnit.ts:1959
 
 #### Source
 
-src/dataunit/DataUnit.ts:1983
+src/dataunit/DataUnit.ts:2010
 
 ***
 
@@ -150,4 +164,4 @@ src/dataunit/DataUnit.ts:1983
 
 #### Source
 
-src/dataunit/DataUnit.ts:1987
+src/dataunit/DataUnit.ts:2014

package/enumerations/ChangeOperation.md

@@ -14,7 +14,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1831
+src/dataunit/DataUnit.ts:1854
 
 ***
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1831
 
 #### Source
 
-src/dataunit/DataUnit.ts:1833
+src/dataunit/DataUnit.ts:1856
 
 ***
 
@@ -34,7 +34,7 @@ src/dataunit/DataUnit.ts:1833
 
 #### Source
 
-src/dataunit/DataUnit.ts:1830
+src/dataunit/DataUnit.ts:1853
 
 ***
 
@@ -44,4 +44,4 @@ src/dataunit/DataUnit.ts:1830
 
 #### Source
 
-src/dataunit/DataUnit.ts:1832
+src/dataunit/DataUnit.ts:1855

package/enumerations/SelectionMode.md

@@ -14,7 +14,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1939
+src/dataunit/DataUnit.ts:1962
 
 ***
 
@@ -24,4 +24,4 @@ src/dataunit/DataUnit.ts:1939
 
 #### Source
 
-src/dataunit/DataUnit.ts:1940
+src/dataunit/DataUnit.ts:1963

package/interfaces/DUActionInterceptor.md

@@ -22,4 +22,4 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1814
+src/dataunit/DataUnit.ts:1837

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:1919
+src/dataunit/DataUnit.ts:1942
 
 ***
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1919
 
 #### Source
 
-src/dataunit/DataUnit.ts:1920
+src/dataunit/DataUnit.ts:1943
 
 ***
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1920
 
 #### Source
 
-src/dataunit/DataUnit.ts:1921
+src/dataunit/DataUnit.ts:1944

package/interfaces/QuickFilter.md

@@ -14,7 +14,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1926
+src/dataunit/DataUnit.ts:1949
 
 ***
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1926
 
 #### Source
 
-src/dataunit/DataUnit.ts:1927
+src/dataunit/DataUnit.ts:1950
 
 ***
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1927
 
 #### Source
 
-src/dataunit/DataUnit.ts:1925
+src/dataunit/DataUnit.ts:1948

package/interfaces/Record.md

@@ -22,7 +22,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1821
+src/dataunit/DataUnit.ts:1844
 
 ***
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1821
 
 #### Source
 
-src/dataunit/DataUnit.ts:1820
+src/dataunit/DataUnit.ts:1843
 
 ***
 
@@ -42,7 +42,7 @@ src/dataunit/DataUnit.ts:1820
 
 #### Source
 
-src/dataunit/DataUnit.ts:1818
+src/dataunit/DataUnit.ts:1841
 
 ***
 
@@ -52,4 +52,4 @@ src/dataunit/DataUnit.ts:1818
 
 #### Source
 
-src/dataunit/DataUnit.ts:1819
+src/dataunit/DataUnit.ts:1842

package/interfaces/SavedRecord.md

@@ -18,7 +18,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1826
+src/dataunit/DataUnit.ts:1849
 
 ***
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1826
 
 #### Source
 
-src/dataunit/DataUnit.ts:1821
+src/dataunit/DataUnit.ts:1844
 
 ***
 
@@ -46,7 +46,7 @@ src/dataunit/DataUnit.ts:1821
 
 #### Source
 
-src/dataunit/DataUnit.ts:1820
+src/dataunit/DataUnit.ts:1843
 
 ***
 
@@ -60,7 +60,7 @@ src/dataunit/DataUnit.ts:1820
 
 #### Source
 
-src/dataunit/DataUnit.ts:1818
+src/dataunit/DataUnit.ts:1841
 
 ***
 
@@ -74,4 +74,4 @@ src/dataunit/DataUnit.ts:1818
 
 #### Source
 
-src/dataunit/DataUnit.ts:1819
+src/dataunit/DataUnit.ts:1842

package/interfaces/WaitingChange.md

@@ -14,7 +14,7 @@
 
 #### Source
 
-src/dataunit/DataUnit.ts:1914
+src/dataunit/DataUnit.ts:1937
 
 ***
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1914
 
 #### Source
 
-src/dataunit/DataUnit.ts:1915
+src/dataunit/DataUnit.ts:1938
 
 ***
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1915
 
 #### Source
 
-src/dataunit/DataUnit.ts:1913
+src/dataunit/DataUnit.ts:1936

package/namespaces/MaskFormatter/type-aliases/MaskCharacter.md

@@ -10,4 +10,4 @@
 
 ## Source
 
-src/utils/MaskFormatter.ts:166
+src/utils/MaskFormatter.ts:170

package/namespaces/MaskFormatter/variables/MaskCharacter.md

@@ -10,4 +10,4 @@
 
 ## Source
 
-src/utils/MaskFormatter.ts:166
+src/utils/MaskFormatter.ts:170

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@sankhyalabs/core-docs",
-    "version": "5.20.0-rc.17",
+    "version": "5.20.0-rc.19",
     "description": "Documentação da biblioteca de componentes Sankhya.",
     "main": "",
     "files": [

package/type-aliases/DataUnitEventOptions.md

@@ -14,4 +14,4 @@
 
 ## Source
 
-src/dataunit/DataUnit.ts:1992
+src/dataunit/DataUnit.ts:2019