@sankhyalabs/core-docs 5.20.0-dev.31 → 5.20.0-dev.33

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (19) hide show
  1. package/classes/Change.md +11 -11
  2. package/classes/DataUnit.md +179 -129
  3. package/classes/IDBRepository.md +22 -0
  4. package/classes/MaskFormatter.md +13 -9
  5. package/classes/SelectionInfo.md +25 -11
  6. package/enumerations/ChangeOperation.md +4 -4
  7. package/enumerations/SelectionMode.md +2 -2
  8. package/interfaces/DUActionInterceptor.md +1 -1
  9. package/interfaces/IRepository.md +18 -0
  10. package/interfaces/LoadDataRequest.md +1 -1
  11. package/interfaces/PageRequest.md +3 -3
  12. package/interfaces/QuickFilter.md +3 -3
  13. package/interfaces/Record.md +4 -4
  14. package/interfaces/SavedRecord.md +5 -5
  15. package/interfaces/WaitingChange.md +3 -3
  16. package/namespaces/MaskFormatter/type-aliases/MaskCharacter.md +1 -1
  17. package/namespaces/MaskFormatter/variables/MaskCharacter.md +1 -1
  18. package/package.json +1 -1
  19. package/type-aliases/DataUnitEventOptions.md +1 -1
package/classes/IDBRepository.md CHANGED
@@ -279,6 +279,28 @@ src/repository/indexeddb/IDBRepository.ts:319
279
279
 
280
280
  ***
281
281
 
282
+ ### getFromCache()
283
+
284
+ > **getFromCache**(): `undefined` \| `T`[]
285
+
286
+ Retorna todos os registros que estão em cache no momento
287
+
288
+ #### Returns
289
+
290
+ `undefined` \| `T`[]
291
+
292
+ Todos registros que estão em cache no momento
293
+
294
+ #### Implementation of
295
+
296
+ [`IRepository`](../interfaces/IRepository.md).[`getFromCache`](../interfaces/IRepository.md#getfromcache)
297
+
298
+ #### Source
299
+
300
+ src/repository/indexeddb/IDBRepository.ts:324
301
+
302
+ ***
303
+
282
304
  ### getItemPosition()
283
305
 
284
306
  > `private` **getItemPosition**(`db`, `itemTest`): `Promise`\<`number`\>
package/classes/MaskFormatter.md CHANGED
@@ -129,7 +129,7 @@ src/utils/MaskFormatter.ts:55
129
129
 
130
130
  #### Source
131
131
 
132
- src/utils/MaskFormatter.ts:375
132
+ src/utils/MaskFormatter.ts:379
133
133
 
134
134
  ***
135
135
 
@@ -149,7 +149,7 @@ src/utils/MaskFormatter.ts:54
149
149
 
150
150
  #### Source
151
151
 
152
- src/utils/MaskFormatter.ts:389
152
+ src/utils/MaskFormatter.ts:393
153
153
 
154
154
  ***
155
155
 
@@ -179,7 +179,7 @@ src/utils/MaskFormatter.ts:49
179
179
 
180
180
  #### Source
181
181
 
182
- src/utils/MaskFormatter.ts:300
182
+ src/utils/MaskFormatter.ts:304
183
183
 
184
184
  ***
185
185
 
@@ -209,7 +209,7 @@ src/utils/MaskFormatter.ts:52
209
209
 
210
210
  #### Source
211
211
 
212
- src/utils/MaskFormatter.ts:281
212
+ src/utils/MaskFormatter.ts:285
213
213
 
214
214
  ***
215
215
 
@@ -219,7 +219,7 @@ src/utils/MaskFormatter.ts:281
219
219
 
220
220
  #### Source
221
221
 
222
- src/utils/MaskFormatter.ts:352
222
+ src/utils/MaskFormatter.ts:356
223
223
 
224
224
  ***
225
225
 
@@ -239,7 +239,7 @@ src/utils/MaskFormatter.ts:51
239
239
 
240
240
  #### Source
241
241
 
242
- src/utils/MaskFormatter.ts:329
242
+ src/utils/MaskFormatter.ts:333
243
243
 
244
244
  ## Accessors
245
245
 
@@ -271,7 +271,7 @@ src/utils/MaskFormatter.ts:87
271
271
 
272
272
  ### format()
273
273
 
274
- > **format**(`value`): `string`
274
+ > **format**(`value`, `trimBefore`): `string`
275
275
 
276
276
  Formata a string passada baseada na máscara definda pelo atributo mask.
277
277
 
@@ -281,6 +281,10 @@ Formata a string passada baseada na máscara definda pelo atributo mask.
281
281
 
282
282
  Valor a ser formatado.
283
283
 
284
+ • **trimBefore**: `boolean`= `false`
285
+
286
+ Executa um trim para remover espaços em branco.
287
+
284
288
  #### Returns
285
289
 
286
290
  `string`
@@ -289,7 +293,7 @@ O valor processado de acordo com o padrão.
289
293
 
290
294
  #### Source
291
295
 
292
- src/utils/MaskFormatter.ts:101
296
+ src/utils/MaskFormatter.ts:102
293
297
 
294
298
  ***
295
299
 
@@ -305,4 +309,4 @@ Prepara a formatação internamente de acordo com o padrão.
305
309
 
306
310
  #### Source
307
311
 
308
- src/utils/MaskFormatter.ts:118
312
+ src/utils/MaskFormatter.ts:122
package/classes/SelectionInfo.md CHANGED
@@ -30,7 +30,7 @@
30
30
 
31
31
  #### Source
32
32
 
33
- src/dataunit/DataUnit.ts:1927
33
+ src/dataunit/DataUnit.ts:1953
34
34
 
35
35
  ## Properties
36
36
 
@@ -40,7 +40,7 @@ src/dataunit/DataUnit.ts:1927
40
40
 
41
41
  #### Source
42
42
 
43
- src/dataunit/DataUnit.ts:1921
43
+ src/dataunit/DataUnit.ts:1950
44
44
 
45
45
  ***
46
46
 
@@ -50,7 +50,7 @@ src/dataunit/DataUnit.ts:1921
50
50
 
51
51
  #### Source
52
52
 
53
- src/dataunit/DataUnit.ts:1923
53
+ src/dataunit/DataUnit.ts:1951
54
54
 
55
55
  ***
56
56
 
@@ -60,7 +60,21 @@ src/dataunit/DataUnit.ts:1923
60
60
 
61
61
  #### Source
62
62
 
63
- src/dataunit/DataUnit.ts:1924
63
+ src/dataunit/DataUnit.ts:1947
64
+
65
+ ***
66
+
67
+ ### getAllRecords()?
68
+
69
+ > `optional` **getAllRecords**: () => `undefined` \| [`Record`](../interfaces/Record.md)[]
70
+
71
+ #### Returns
72
+
73
+ `undefined` \| [`Record`](../interfaces/Record.md)[]
74
+
75
+ #### Source
76
+
77
+ src/dataunit/DataUnit.ts:1949
64
78
 
65
79
  ***
66
80
 
@@ -70,7 +84,7 @@ src/dataunit/DataUnit.ts:1924
70
84
 
71
85
  #### Source
72
86
 
73
- src/dataunit/DataUnit.ts:1922
87
+ src/dataunit/DataUnit.ts:1946
74
88
 
75
89
  ***
76
90
 
@@ -80,7 +94,7 @@ src/dataunit/DataUnit.ts:1922
80
94
 
81
95
  #### Source
82
96
 
83
- src/dataunit/DataUnit.ts:1925
97
+ src/dataunit/DataUnit.ts:1948
84
98
 
85
99
  ## Accessors
86
100
 
@@ -94,7 +108,7 @@ src/dataunit/DataUnit.ts:1925
94
108
 
95
109
  #### Source
96
110
 
97
- src/dataunit/DataUnit.ts:1952
111
+ src/dataunit/DataUnit.ts:1981
98
112
 
99
113
  ***
100
114
 
@@ -108,7 +122,7 @@ src/dataunit/DataUnit.ts:1952
108
122
 
109
123
  #### Source
110
124
 
111
- src/dataunit/DataUnit.ts:1942
125
+ src/dataunit/DataUnit.ts:1971
112
126
 
113
127
  ***
114
128
 
@@ -122,7 +136,7 @@ src/dataunit/DataUnit.ts:1942
122
136
 
123
137
  #### Source
124
138
 
125
- src/dataunit/DataUnit.ts:1935
139
+ src/dataunit/DataUnit.ts:1961
126
140
 
127
141
  ## Methods
128
142
 
@@ -136,7 +150,7 @@ src/dataunit/DataUnit.ts:1935
136
150
 
137
151
  #### Source
138
152
 
139
- src/dataunit/DataUnit.ts:1959
153
+ src/dataunit/DataUnit.ts:1988
140
154
 
141
155
  ***
142
156
 
@@ -150,4 +164,4 @@ src/dataunit/DataUnit.ts:1959
150
164
 
151
165
  #### Source
152
166
 
153
- src/dataunit/DataUnit.ts:1963
167
+ src/dataunit/DataUnit.ts:1992
package/enumerations/ChangeOperation.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1807
17
+ src/dataunit/DataUnit.ts:1832
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1807
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1809
27
+ src/dataunit/DataUnit.ts:1834
28
28
 
29
29
  ***
30
30
 
@@ -34,7 +34,7 @@ src/dataunit/DataUnit.ts:1809
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1806
37
+ src/dataunit/DataUnit.ts:1831
38
38
 
39
39
  ***
40
40
 
@@ -44,4 +44,4 @@ src/dataunit/DataUnit.ts:1806
44
44
 
45
45
  #### Source
46
46
 
47
- src/dataunit/DataUnit.ts:1808
47
+ src/dataunit/DataUnit.ts:1833
package/enumerations/SelectionMode.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1915
17
+ src/dataunit/DataUnit.ts:1940
18
18
 
19
19
  ***
20
20
 
@@ -24,4 +24,4 @@ src/dataunit/DataUnit.ts:1915
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1916
27
+ src/dataunit/DataUnit.ts:1941
package/interfaces/DUActionInterceptor.md CHANGED
@@ -22,4 +22,4 @@
22
22
 
23
23
  #### Source
24
24
 
25
- src/dataunit/DataUnit.ts:1790
25
+ src/dataunit/DataUnit.ts:1815
package/interfaces/IRepository.md CHANGED
@@ -96,6 +96,24 @@ src/repository/IRepository.ts:23
96
96
 
97
97
  ***
98
98
 
99
+ ### getFromCache()
100
+
101
+ > **getFromCache**(): `undefined` \| `T`[]
102
+
103
+ Retorna todos os registros que estão em cache no momento
104
+
105
+ #### Returns
106
+
107
+ `undefined` \| `T`[]
108
+
109
+ Todos registros que estão em cache no momento
110
+
111
+ #### Source
112
+
113
+ src/repository/IRepository.ts:88
114
+
115
+ ***
116
+
99
117
  ### insert()
100
118
 
101
119
  > **insert**(`itemReference`, `items`): `Promise`\<`void`\>
package/interfaces/LoadDataRequest.md CHANGED
@@ -96,7 +96,7 @@ src/dataunit/loading/LoadDataRequest.ts:22
96
96
 
97
97
  ### source?
98
98
 
99
- > `optional` **source**: `String`
99
+ > `optional` **source**: `string`
100
100
 
101
101
  De onde partiu o refresh. Por padrão a fonte não é identificada
102
102
 
package/interfaces/PageRequest.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1895
17
+ src/dataunit/DataUnit.ts:1920
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1895
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1896
27
+ src/dataunit/DataUnit.ts:1921
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1896
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1897
37
+ src/dataunit/DataUnit.ts:1922
package/interfaces/QuickFilter.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1902
17
+ src/dataunit/DataUnit.ts:1927
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1902
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1903
27
+ src/dataunit/DataUnit.ts:1928
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1903
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1901
37
+ src/dataunit/DataUnit.ts:1926
package/interfaces/Record.md CHANGED
@@ -22,7 +22,7 @@
22
22
 
23
23
  #### Source
24
24
 
25
- src/dataunit/DataUnit.ts:1797
25
+ src/dataunit/DataUnit.ts:1822
26
26
 
27
27
  ***
28
28
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1797
32
32
 
33
33
  #### Source
34
34
 
35
- src/dataunit/DataUnit.ts:1796
35
+ src/dataunit/DataUnit.ts:1821
36
36
 
37
37
  ***
38
38
 
@@ -42,7 +42,7 @@ src/dataunit/DataUnit.ts:1796
42
42
 
43
43
  #### Source
44
44
 
45
- src/dataunit/DataUnit.ts:1794
45
+ src/dataunit/DataUnit.ts:1819
46
46
 
47
47
  ***
48
48
 
@@ -52,4 +52,4 @@ src/dataunit/DataUnit.ts:1794
52
52
 
53
53
  #### Source
54
54
 
55
- src/dataunit/DataUnit.ts:1795
55
+ src/dataunit/DataUnit.ts:1820
package/interfaces/SavedRecord.md CHANGED
@@ -18,7 +18,7 @@
18
18
 
19
19
  #### Source
20
20
 
21
- src/dataunit/DataUnit.ts:1802
21
+ src/dataunit/DataUnit.ts:1827
22
22
 
23
23
  ***
24
24
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1802
32
32
 
33
33
  #### Source
34
34
 
35
- src/dataunit/DataUnit.ts:1797
35
+ src/dataunit/DataUnit.ts:1822
36
36
 
37
37
  ***
38
38
 
@@ -46,7 +46,7 @@ src/dataunit/DataUnit.ts:1797
46
46
 
47
47
  #### Source
48
48
 
49
- src/dataunit/DataUnit.ts:1796
49
+ src/dataunit/DataUnit.ts:1821
50
50
 
51
51
  ***
52
52
 
@@ -60,7 +60,7 @@ src/dataunit/DataUnit.ts:1796
60
60
 
61
61
  #### Source
62
62
 
63
- src/dataunit/DataUnit.ts:1794
63
+ src/dataunit/DataUnit.ts:1819
64
64
 
65
65
  ***
66
66
 
@@ -74,4 +74,4 @@ src/dataunit/DataUnit.ts:1794
74
74
 
75
75
  #### Source
76
76
 
77
- src/dataunit/DataUnit.ts:1795
77
+ src/dataunit/DataUnit.ts:1820
package/interfaces/WaitingChange.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1890
17
+ src/dataunit/DataUnit.ts:1915
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1890
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1891
27
+ src/dataunit/DataUnit.ts:1916
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1891
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1889
37
+ src/dataunit/DataUnit.ts:1914
package/namespaces/MaskFormatter/type-aliases/MaskCharacter.md CHANGED
@@ -10,4 +10,4 @@
10
10
 
11
11
  ## Source
12
12
 
13
- src/utils/MaskFormatter.ts:166
13
+ src/utils/MaskFormatter.ts:170
package/namespaces/MaskFormatter/variables/MaskCharacter.md CHANGED
@@ -10,4 +10,4 @@
10
10
 
11
11
  ## Source
12
12
 
13
- src/utils/MaskFormatter.ts:166
13
+ src/utils/MaskFormatter.ts:170
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/core-docs",
3
- "version": "5.20.0-dev.31",
3
+ "version": "5.20.0-dev.33",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [
package/type-aliases/DataUnitEventOptions.md CHANGED
@@ -14,4 +14,4 @@
14
14
 
15
15
  ## Source
16
16
 
17
- src/dataunit/DataUnit.ts:1968
17
+ src/dataunit/DataUnit.ts:1997