@sankhyalabs/core-docs 0.0.0-feat-dev-KB-44339.0 → 0.0.0-feat-dev-KB-42648-3.1

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 (15) hide show
  1. package/classes/Change.md +11 -11
  2. package/classes/DataUnit.md +152 -256
  3. package/classes/IDBRepository.md +22 -0
  4. package/classes/SelectionInfo.md +36 -61
  5. package/enumerations/ChangeOperation.md +4 -4
  6. package/enumerations/SelectionMode.md +2 -2
  7. package/interfaces/DUActionInterceptor.md +1 -1
  8. package/interfaces/IRepository.md +18 -0
  9. package/interfaces/PageRequest.md +3 -3
  10. package/interfaces/QuickFilter.md +3 -3
  11. package/interfaces/Record.md +4 -4
  12. package/interfaces/SavedRecord.md +5 -5
  13. package/interfaces/WaitingChange.md +3 -3
  14. package/package.json +1 -1
  15. 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/SelectionInfo.md CHANGED
@@ -4,14 +4,7 @@
4
4
 
5
5
  [@sankhyalabs/core](../globals.md) / SelectionInfo
6
6
 
7
- # Class: ~~SelectionInfo~~
8
-
9
- ## Deprecated
10
-
11
- - Classe deprecada.
12
- Devido a seleção virtual baseada em critérios e ordenação (ALL_RECORDS), essa
13
- classe foi descontinuado e pode retornar erros no caso da seleção virtual.
14
- Utilizar o AsyncSelectionInfo.
7
+ # Class: SelectionInfo
15
8
 
16
9
  ## Constructors
17
10
 
@@ -37,127 +30,117 @@ Utilizar o AsyncSelectionInfo.
37
30
 
38
31
  #### Source
39
32
 
40
- src/dataunit/DataUnit.ts:2033
33
+ src/dataunit/DataUnit.ts:1939
41
34
 
42
35
  ## Properties
43
36
 
44
- ### ~~\_records~~
37
+ ### \_records
45
38
 
46
39
  > `private` **\_records**: [`Record`](../interfaces/Record.md)[]
47
40
 
48
41
  #### Source
49
42
 
50
- src/dataunit/DataUnit.ts:2030
43
+ src/dataunit/DataUnit.ts:1936
51
44
 
52
45
  ***
53
46
 
54
- ### ~~\_total?~~
47
+ ### \_total?
55
48
 
56
49
  > `private` `optional` **\_total**: `number`
57
50
 
58
51
  #### Source
59
52
 
60
- src/dataunit/DataUnit.ts:2031
53
+ src/dataunit/DataUnit.ts:1937
61
54
 
62
55
  ***
63
56
 
64
- ### ~~filters?~~
57
+ ### filters?
65
58
 
66
59
  > `optional` **filters**: [`Filter`](../interfaces/Filter.md)[]
67
60
 
68
61
  #### Source
69
62
 
70
- src/dataunit/DataUnit.ts:2028
63
+ src/dataunit/DataUnit.ts:1933
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:1935
71
78
 
72
79
  ***
73
80
 
74
- ### ~~mode~~
81
+ ### mode
75
82
 
76
83
  > **mode**: [`SelectionMode`](../enumerations/SelectionMode.md)
77
84
 
78
85
  #### Source
79
86
 
80
- src/dataunit/DataUnit.ts:2027
87
+ src/dataunit/DataUnit.ts:1932
81
88
 
82
89
  ***
83
90
 
84
- ### ~~sort?~~
91
+ ### sort?
85
92
 
86
93
  > `optional` **sort**: [`Sort`](../interfaces/Sort.md)[]
87
94
 
88
95
  #### Source
89
96
 
90
- src/dataunit/DataUnit.ts:2029
97
+ src/dataunit/DataUnit.ts:1934
91
98
 
92
99
  ## Accessors
93
100
 
94
- ### ~~length~~
101
+ ### length
95
102
 
96
103
  > `get` **length**(): `number`
97
104
 
98
- Retorna a quantidade de registros do DataUnit.
99
-
100
- #### Deprecated
101
-
102
- - Método deprecado.
103
- Devido a seleção virtual baseada em critérios e ordenação (ALL_RECORDS), esse
104
- método foi descontinuado e pode retornar erros no caso da seleção virtual.
105
-
106
105
  #### Returns
107
106
 
108
107
  `number`
109
108
 
110
109
  #### Source
111
110
 
112
- src/dataunit/DataUnit.ts:2085
111
+ src/dataunit/DataUnit.ts:1967
113
112
 
114
113
  ***
115
114
 
116
- ### ~~recordIds~~
115
+ ### recordIds
117
116
 
118
117
  > `get` **recordIds**(): `undefined` \| `string`[]
119
118
 
120
- Retorna os IDs dos registros selecionados.
121
-
122
- #### Deprecated
123
-
124
- - Método deprecado.
125
- Devido a seleção virtual baseada em critérios e ordenação (ALL_RECORDS), esse
126
- método foi descontinuado e pode retornar erros no caso da seleção virtual.
127
-
128
119
  #### Returns
129
120
 
130
121
  `undefined` \| `string`[]
131
122
 
132
123
  #### Source
133
124
 
134
- src/dataunit/DataUnit.ts:2065
125
+ src/dataunit/DataUnit.ts:1957
135
126
 
136
127
  ***
137
128
 
138
- ### ~~records~~
129
+ ### records
139
130
 
140
131
  > `get` **records**(): `undefined` \| [`Record`](../interfaces/Record.md)[]
141
132
 
142
- Busca os registros carregados do DataUnit.
143
-
144
- #### Deprecated
145
-
146
- - Método deprecado.
147
- Devido a seleção virtual baseada em critérios e ordenação (ALL_RECORDS), esse
148
- método foi descontinuado e pode retornar erros no caso da seleção virtual.
149
-
150
133
  #### Returns
151
134
 
152
135
  `undefined` \| [`Record`](../interfaces/Record.md)[]
153
136
 
154
137
  #### Source
155
138
 
156
- src/dataunit/DataUnit.ts:2048
139
+ src/dataunit/DataUnit.ts:1947
157
140
 
158
141
  ## Methods
159
142
 
160
- ### ~~isAllRecords()~~
143
+ ### isAllRecords()
161
144
 
162
145
  > **isAllRecords**(): `boolean`
163
146
 
@@ -167,26 +150,18 @@ src/dataunit/DataUnit.ts:2048
167
150
 
168
151
  #### Source
169
152
 
170
- src/dataunit/DataUnit.ts:2094
153
+ src/dataunit/DataUnit.ts:1974
171
154
 
172
155
  ***
173
156
 
174
- ### ~~isEmpty()~~
157
+ ### isEmpty()
175
158
 
176
159
  > **isEmpty**(): `boolean`
177
160
 
178
- Retorna se a quantidade de registros do DataUnit está vazia.
179
-
180
161
  #### Returns
181
162
 
182
163
  `boolean`
183
164
 
184
- #### Deprecated
185
-
186
- - Método deprecado.
187
- Devido a seleção virtual baseada em critérios e ordenação (ALL_RECORDS), esse
188
- método foi descontinuado e pode retornar erros no caso da seleção virtual.
189
-
190
165
  #### Source
191
166
 
192
- src/dataunit/DataUnit.ts:2105
167
+ src/dataunit/DataUnit.ts:1978
package/enumerations/ChangeOperation.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1907
17
+ src/dataunit/DataUnit.ts:1818
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1907
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1909
27
+ src/dataunit/DataUnit.ts:1820
28
28
 
29
29
  ***
30
30
 
@@ -34,7 +34,7 @@ src/dataunit/DataUnit.ts:1909
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1906
37
+ src/dataunit/DataUnit.ts:1817
38
38
 
39
39
  ***
40
40
 
@@ -44,4 +44,4 @@ src/dataunit/DataUnit.ts:1906
44
44
 
45
45
  #### Source
46
46
 
47
- src/dataunit/DataUnit.ts:1908
47
+ src/dataunit/DataUnit.ts:1819
package/enumerations/SelectionMode.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:2015
17
+ src/dataunit/DataUnit.ts:1926
18
18
 
19
19
  ***
20
20
 
@@ -24,4 +24,4 @@ src/dataunit/DataUnit.ts:2015
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:2016
27
+ src/dataunit/DataUnit.ts:1927
package/interfaces/DUActionInterceptor.md CHANGED
@@ -22,4 +22,4 @@
22
22
 
23
23
  #### Source
24
24
 
25
- src/dataunit/DataUnit.ts:1890
25
+ src/dataunit/DataUnit.ts:1801
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/PageRequest.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1995
17
+ src/dataunit/DataUnit.ts:1906
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1995
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1996
27
+ src/dataunit/DataUnit.ts:1907
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1996
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1997
37
+ src/dataunit/DataUnit.ts:1908
package/interfaces/QuickFilter.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:2002
17
+ src/dataunit/DataUnit.ts:1913
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:2002
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:2003
27
+ src/dataunit/DataUnit.ts:1914
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:2003
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:2001
37
+ src/dataunit/DataUnit.ts:1912
package/interfaces/Record.md CHANGED
@@ -22,7 +22,7 @@
22
22
 
23
23
  #### Source
24
24
 
25
- src/dataunit/DataUnit.ts:1897
25
+ src/dataunit/DataUnit.ts:1808
26
26
 
27
27
  ***
28
28
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1897
32
32
 
33
33
  #### Source
34
34
 
35
- src/dataunit/DataUnit.ts:1896
35
+ src/dataunit/DataUnit.ts:1807
36
36
 
37
37
  ***
38
38
 
@@ -42,7 +42,7 @@ src/dataunit/DataUnit.ts:1896
42
42
 
43
43
  #### Source
44
44
 
45
- src/dataunit/DataUnit.ts:1894
45
+ src/dataunit/DataUnit.ts:1805
46
46
 
47
47
  ***
48
48
 
@@ -52,4 +52,4 @@ src/dataunit/DataUnit.ts:1894
52
52
 
53
53
  #### Source
54
54
 
55
- src/dataunit/DataUnit.ts:1895
55
+ src/dataunit/DataUnit.ts:1806
package/interfaces/SavedRecord.md CHANGED
@@ -18,7 +18,7 @@
18
18
 
19
19
  #### Source
20
20
 
21
- src/dataunit/DataUnit.ts:1902
21
+ src/dataunit/DataUnit.ts:1813
22
22
 
23
23
  ***
24
24
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1902
32
32
 
33
33
  #### Source
34
34
 
35
- src/dataunit/DataUnit.ts:1897
35
+ src/dataunit/DataUnit.ts:1808
36
36
 
37
37
  ***
38
38
 
@@ -46,7 +46,7 @@ src/dataunit/DataUnit.ts:1897
46
46
 
47
47
  #### Source
48
48
 
49
- src/dataunit/DataUnit.ts:1896
49
+ src/dataunit/DataUnit.ts:1807
50
50
 
51
51
  ***
52
52
 
@@ -60,7 +60,7 @@ src/dataunit/DataUnit.ts:1896
60
60
 
61
61
  #### Source
62
62
 
63
- src/dataunit/DataUnit.ts:1894
63
+ src/dataunit/DataUnit.ts:1805
64
64
 
65
65
  ***
66
66
 
@@ -74,4 +74,4 @@ src/dataunit/DataUnit.ts:1894
74
74
 
75
75
  #### Source
76
76
 
77
- src/dataunit/DataUnit.ts:1895
77
+ src/dataunit/DataUnit.ts:1806
package/interfaces/WaitingChange.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1990
17
+ src/dataunit/DataUnit.ts:1901
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1990
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1991
27
+ src/dataunit/DataUnit.ts:1902
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1991
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1989
37
+ src/dataunit/DataUnit.ts:1900
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/core-docs",
3
- "version": "0.0.0-feat-dev-KB-44339.0",
3
+ "version": "0.0.0-feat-dev-KB-42648-3.1",
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:2112
17
+ src/dataunit/DataUnit.ts:1983