@sankhyalabs/core-docs 0.0.0-feat-dev-KB-45934.0 → 0.0.0-feat-dev-KB-45934.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 (14) hide show
  1. package/classes/Change.md +11 -11
  2. package/classes/DataUnit.md +282 -136
  3. package/classes/ObjectUtils.md +48 -0
  4. package/classes/SelectionInfo.md +65 -40
  5. package/enumerations/ChangeOperation.md +4 -4
  6. package/enumerations/SelectionMode.md +2 -2
  7. package/interfaces/DUActionInterceptor.md +1 -1
  8. package/interfaces/PageRequest.md +3 -3
  9. package/interfaces/QuickFilter.md +3 -3
  10. package/interfaces/Record.md +4 -4
  11. package/interfaces/SavedRecord.md +5 -5
  12. package/interfaces/WaitingChange.md +3 -3
  13. package/package.json +1 -1
  14. package/type-aliases/DataUnitEventOptions.md +1 -1
package/classes/ObjectUtils.md CHANGED
@@ -76,6 +76,54 @@ src/utils/ObjectUtils.ts:84
76
76
 
77
77
  ***
78
78
 
79
+ ### isEmpty()
80
+
81
+ > `static` **isEmpty**(`obj`): `boolean`
82
+
83
+ Verifica se o objeto está vazio (sem atributos).
84
+
85
+ #### Parameters
86
+
87
+ • **obj**: `object`
88
+
89
+ Objeto a ser verificado.
90
+
91
+ #### Returns
92
+
93
+ `boolean`
94
+
95
+ - True caso o objeto esteja vazio.
96
+
97
+ #### Source
98
+
99
+ src/utils/ObjectUtils.ts:94
100
+
101
+ ***
102
+
103
+ ### isNotEmpty()
104
+
105
+ > `static` **isNotEmpty**(`obj`): `boolean`
106
+
107
+ Verifica se o objeto NÃO está vazio (sem atributos).
108
+
109
+ #### Parameters
110
+
111
+ • **obj**: `object`
112
+
113
+ Objeto a ser verificado.
114
+
115
+ #### Returns
116
+
117
+ `boolean`
118
+
119
+ - True caso o objeto NÃO esteja vazio
120
+
121
+ #### Source
122
+
123
+ src/utils/ObjectUtils.ts:104
124
+
125
+ ***
126
+
79
127
  ### objectToString()
80
128
 
81
129
  > `static` **objectToString**(`data`): `string`
package/classes/SelectionInfo.md CHANGED
@@ -4,7 +4,14 @@
4
4
 
5
5
  [@sankhyalabs/core](../globals.md) / SelectionInfo
6
6
 
7
- # Class: SelectionInfo
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.
8
15
 
9
16
  ## Constructors
10
17
 
@@ -30,117 +37,127 @@
30
37
 
31
38
  #### Source
32
39
 
33
- src/dataunit/DataUnit.ts:1940
40
+ src/dataunit/DataUnit.ts:2033
34
41
 
35
42
  ## Properties
36
43
 
37
- ### \_records
44
+ ### ~~\_records~~
38
45
 
39
46
  > `private` **\_records**: [`Record`](../interfaces/Record.md)[]
40
47
 
41
48
  #### Source
42
49
 
43
- src/dataunit/DataUnit.ts:1937
50
+ src/dataunit/DataUnit.ts:2030
44
51
 
45
52
  ***
46
53
 
47
- ### \_total?
54
+ ### ~~\_total?~~
48
55
 
49
56
  > `private` `optional` **\_total**: `number`
50
57
 
51
58
  #### Source
52
59
 
53
- src/dataunit/DataUnit.ts:1938
60
+ src/dataunit/DataUnit.ts:2031
54
61
 
55
62
  ***
56
63
 
57
- ### filters?
64
+ ### ~~filters?~~
58
65
 
59
66
  > `optional` **filters**: [`Filter`](../interfaces/Filter.md)[]
60
67
 
61
68
  #### Source
62
69
 
63
- src/dataunit/DataUnit.ts:1934
64
-
65
- ***
66
-
67
- ### getAllRecords()?
68
-
69
- > `optional` **getAllRecords**: () => `undefined` \| `Promise`\<[`Record`](../interfaces/Record.md)[]\>
70
-
71
- #### Returns
72
-
73
- `undefined` \| `Promise`\<[`Record`](../interfaces/Record.md)[]\>
74
-
75
- #### Source
76
-
77
- src/dataunit/DataUnit.ts:1936
70
+ src/dataunit/DataUnit.ts:2028
78
71
 
79
72
  ***
80
73
 
81
- ### mode
74
+ ### ~~mode~~
82
75
 
83
76
  > **mode**: [`SelectionMode`](../enumerations/SelectionMode.md)
84
77
 
85
78
  #### Source
86
79
 
87
- src/dataunit/DataUnit.ts:1933
80
+ src/dataunit/DataUnit.ts:2027
88
81
 
89
82
  ***
90
83
 
91
- ### sort?
84
+ ### ~~sort?~~
92
85
 
93
86
  > `optional` **sort**: [`Sort`](../interfaces/Sort.md)[]
94
87
 
95
88
  #### Source
96
89
 
97
- src/dataunit/DataUnit.ts:1935
90
+ src/dataunit/DataUnit.ts:2029
98
91
 
99
92
  ## Accessors
100
93
 
101
- ### length
94
+ ### ~~length~~
102
95
 
103
96
  > `get` **length**(): `number`
104
97
 
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
+
105
106
  #### Returns
106
107
 
107
108
  `number`
108
109
 
109
110
  #### Source
110
111
 
111
- src/dataunit/DataUnit.ts:1975
112
+ src/dataunit/DataUnit.ts:2085
112
113
 
113
114
  ***
114
115
 
115
- ### recordIds
116
+ ### ~~recordIds~~
117
+
118
+ > `get` **recordIds**(): `undefined` \| `string`[]
119
+
120
+ Retorna os IDs dos registros selecionados.
121
+
122
+ #### Deprecated
116
123
 
117
- > `get` **recordIds**(): `undefined` \| `string`[] \| `Promise`\<`string`[]\>
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.
118
127
 
119
128
  #### Returns
120
129
 
121
- `undefined` \| `string`[] \| `Promise`\<`string`[]\>
130
+ `undefined` \| `string`[]
122
131
 
123
132
  #### Source
124
133
 
125
- src/dataunit/DataUnit.ts:1958
134
+ src/dataunit/DataUnit.ts:2065
126
135
 
127
136
  ***
128
137
 
129
- ### records
138
+ ### ~~records~~
130
139
 
131
- > `get` **records**(): `undefined` \| [`Record`](../interfaces/Record.md)[] \| `Promise`\<[`Record`](../interfaces/Record.md)[]\>
140
+ > `get` **records**(): `undefined` \| [`Record`](../interfaces/Record.md)[]
141
+
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.
132
149
 
133
150
  #### Returns
134
151
 
135
- `undefined` \| [`Record`](../interfaces/Record.md)[] \| `Promise`\<[`Record`](../interfaces/Record.md)[]\>
152
+ `undefined` \| [`Record`](../interfaces/Record.md)[]
136
153
 
137
154
  #### Source
138
155
 
139
- src/dataunit/DataUnit.ts:1948
156
+ src/dataunit/DataUnit.ts:2048
140
157
 
141
158
  ## Methods
142
159
 
143
- ### isAllRecords()
160
+ ### ~~isAllRecords()~~
144
161
 
145
162
  > **isAllRecords**(): `boolean`
146
163
 
@@ -150,18 +167,26 @@ src/dataunit/DataUnit.ts:1948
150
167
 
151
168
  #### Source
152
169
 
153
- src/dataunit/DataUnit.ts:1982
170
+ src/dataunit/DataUnit.ts:2094
154
171
 
155
172
  ***
156
173
 
157
- ### isEmpty()
174
+ ### ~~isEmpty()~~
158
175
 
159
176
  > **isEmpty**(): `boolean`
160
177
 
178
+ Retorna se a quantidade de registros do DataUnit está vazia.
179
+
161
180
  #### Returns
162
181
 
163
182
  `boolean`
164
183
 
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
+
165
190
  #### Source
166
191
 
167
- src/dataunit/DataUnit.ts:1986
192
+ src/dataunit/DataUnit.ts:2105
package/enumerations/ChangeOperation.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1819
17
+ src/dataunit/DataUnit.ts:1907
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1819
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1821
27
+ src/dataunit/DataUnit.ts:1909
28
28
 
29
29
  ***
30
30
 
@@ -34,7 +34,7 @@ src/dataunit/DataUnit.ts:1821
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1818
37
+ src/dataunit/DataUnit.ts:1906
38
38
 
39
39
  ***
40
40
 
@@ -44,4 +44,4 @@ src/dataunit/DataUnit.ts:1818
44
44
 
45
45
  #### Source
46
46
 
47
- src/dataunit/DataUnit.ts:1820
47
+ src/dataunit/DataUnit.ts:1908
package/enumerations/SelectionMode.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1927
17
+ src/dataunit/DataUnit.ts:2015
18
18
 
19
19
  ***
20
20
 
@@ -24,4 +24,4 @@ src/dataunit/DataUnit.ts:1927
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1928
27
+ src/dataunit/DataUnit.ts:2016
package/interfaces/DUActionInterceptor.md CHANGED
@@ -22,4 +22,4 @@
22
22
 
23
23
  #### Source
24
24
 
25
- src/dataunit/DataUnit.ts:1802
25
+ src/dataunit/DataUnit.ts:1890
package/interfaces/PageRequest.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1907
17
+ src/dataunit/DataUnit.ts:1995
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:1908
27
+ src/dataunit/DataUnit.ts:1996
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1908
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1909
37
+ src/dataunit/DataUnit.ts:1997
package/interfaces/QuickFilter.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1914
17
+ src/dataunit/DataUnit.ts:2002
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1914
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1915
27
+ src/dataunit/DataUnit.ts:2003
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1915
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1913
37
+ src/dataunit/DataUnit.ts:2001
package/interfaces/Record.md CHANGED
@@ -22,7 +22,7 @@
22
22
 
23
23
  #### Source
24
24
 
25
- src/dataunit/DataUnit.ts:1809
25
+ src/dataunit/DataUnit.ts:1897
26
26
 
27
27
  ***
28
28
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1809
32
32
 
33
33
  #### Source
34
34
 
35
- src/dataunit/DataUnit.ts:1808
35
+ src/dataunit/DataUnit.ts:1896
36
36
 
37
37
  ***
38
38
 
@@ -42,7 +42,7 @@ src/dataunit/DataUnit.ts:1808
42
42
 
43
43
  #### Source
44
44
 
45
- src/dataunit/DataUnit.ts:1806
45
+ src/dataunit/DataUnit.ts:1894
46
46
 
47
47
  ***
48
48
 
@@ -52,4 +52,4 @@ src/dataunit/DataUnit.ts:1806
52
52
 
53
53
  #### Source
54
54
 
55
- src/dataunit/DataUnit.ts:1807
55
+ src/dataunit/DataUnit.ts:1895
package/interfaces/SavedRecord.md CHANGED
@@ -18,7 +18,7 @@
18
18
 
19
19
  #### Source
20
20
 
21
- src/dataunit/DataUnit.ts:1814
21
+ src/dataunit/DataUnit.ts:1902
22
22
 
23
23
  ***
24
24
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1814
32
32
 
33
33
  #### Source
34
34
 
35
- src/dataunit/DataUnit.ts:1809
35
+ src/dataunit/DataUnit.ts:1897
36
36
 
37
37
  ***
38
38
 
@@ -46,7 +46,7 @@ src/dataunit/DataUnit.ts:1809
46
46
 
47
47
  #### Source
48
48
 
49
- src/dataunit/DataUnit.ts:1808
49
+ src/dataunit/DataUnit.ts:1896
50
50
 
51
51
  ***
52
52
 
@@ -60,7 +60,7 @@ src/dataunit/DataUnit.ts:1808
60
60
 
61
61
  #### Source
62
62
 
63
- src/dataunit/DataUnit.ts:1806
63
+ src/dataunit/DataUnit.ts:1894
64
64
 
65
65
  ***
66
66
 
@@ -74,4 +74,4 @@ src/dataunit/DataUnit.ts:1806
74
74
 
75
75
  #### Source
76
76
 
77
- src/dataunit/DataUnit.ts:1807
77
+ src/dataunit/DataUnit.ts:1895
package/interfaces/WaitingChange.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1902
17
+ src/dataunit/DataUnit.ts:1990
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:1991
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:1989
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/core-docs",
3
- "version": "0.0.0-feat-dev-KB-45934.0",
3
+ "version": "0.0.0-feat-dev-KB-45934.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:1991
17
+ src/dataunit/DataUnit.ts:2112