@sankhyalabs/core-docs 0.0.0-feat-dev-KB-60347.0 → 0.0.0-feat-dev-KB-60347.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 +86 -86
  3. package/classes/ObjectUtils.md +68 -3
  4. package/classes/SelectionInfo.md +12 -12
  5. package/enumerations/Action.md +32 -22
  6. package/enumerations/ChangeOperation.md +4 -4
  7. package/enumerations/SelectionMode.md +2 -2
  8. package/interfaces/DUActionInterceptor.md +1 -1
  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/ObjectUtils.md CHANGED
@@ -76,6 +76,26 @@ src/utils/ObjectUtils.ts:84
76
76
 
77
77
  ***
78
78
 
79
+ ### getComparableProp()
80
+
81
+ > `static` `private` **getComparableProp**(`value`, `propToCompare`): `boolean`
82
+
83
+ #### Parameters
84
+
85
+ • **value**: `any`
86
+
87
+ • **propToCompare**: `string`= `"value"`
88
+
89
+ #### Returns
90
+
91
+ `boolean`
92
+
93
+ #### Source
94
+
95
+ src/utils/ObjectUtils.ts:106
96
+
97
+ ***
98
+
79
99
  ### getProp()
80
100
 
81
101
  > `static` **getProp**(`obj`, `keyPath`): `undefined` \| `Record`\<`string`, `any`\>
@@ -100,7 +120,52 @@ Caminho da propriedade a ser buscada.
100
120
 
101
121
  #### Source
102
122
 
103
- src/utils/ObjectUtils.ts:115
123
+ src/utils/ObjectUtils.ts:140
124
+
125
+ ***
126
+
127
+ ### hasEquivalentProps()
128
+
129
+ > `static` **hasEquivalentProps**(`obj1`, `obj2`, `propToCompare`): `boolean`
130
+
131
+ Compara se o valor de dois items são equivalentes.
132
+ Comparando tanto o valor do item em si, quanto sua propriedade "value"
133
+
134
+ #### Parameters
135
+
136
+ • **obj1**: `any`
137
+
138
+ Objeto a ser comparado.
139
+
140
+ • **obj2**: `any`
141
+
142
+ Objeto a ser comparado.
143
+
144
+ • **propToCompare**: `string`= `"value"`
145
+
146
+ propriedade que deve ser comparada.
147
+
148
+ #### Returns
149
+
150
+ `boolean`
151
+
152
+ - Se o objeto 1 é equivalente ao objeto 2.
153
+
154
+ *
155
+
156
+ #### Examples
157
+
158
+ ```ts
159
+ hasEquivalentProps('123', {value: '123', label: teste}, 'value') | Retorna: true
160
+ ```
161
+
162
+ ```ts
163
+ hasEquivalentProps('xpto', {value: '123', label: teste}, 'propName') | Retorna: false
164
+ ```
165
+
166
+ #### Source
167
+
168
+ src/utils/ObjectUtils.ts:102
104
169
 
105
170
  ***
106
171
 
@@ -124,7 +189,7 @@ Objeto a ser verificado.
124
189
 
125
190
  #### Source
126
191
 
127
- src/utils/ObjectUtils.ts:94
192
+ src/utils/ObjectUtils.ts:119
128
193
 
129
194
  ***
130
195
 
@@ -148,7 +213,7 @@ Objeto a ser verificado.
148
213
 
149
214
  #### Source
150
215
 
151
- src/utils/ObjectUtils.ts:104
216
+ src/utils/ObjectUtils.ts:129
152
217
 
153
218
  ***
154
219
 
package/classes/SelectionInfo.md CHANGED
@@ -30,7 +30,7 @@
30
30
 
31
31
  #### Source
32
32
 
33
- src/dataunit/DataUnit.ts:1969
33
+ src/dataunit/DataUnit.ts:1975
34
34
 
35
35
  ## Properties
36
36
 
@@ -40,7 +40,7 @@ src/dataunit/DataUnit.ts:1969
40
40
 
41
41
  #### Source
42
42
 
43
- src/dataunit/DataUnit.ts:1966
43
+ src/dataunit/DataUnit.ts:1972
44
44
 
45
45
  ***
46
46
 
@@ -50,7 +50,7 @@ src/dataunit/DataUnit.ts:1966
50
50
 
51
51
  #### Source
52
52
 
53
- src/dataunit/DataUnit.ts:1967
53
+ src/dataunit/DataUnit.ts:1973
54
54
 
55
55
  ***
56
56
 
@@ -60,7 +60,7 @@ src/dataunit/DataUnit.ts:1967
60
60
 
61
61
  #### Source
62
62
 
63
- src/dataunit/DataUnit.ts:1963
63
+ src/dataunit/DataUnit.ts:1969
64
64
 
65
65
  ***
66
66
 
@@ -74,7 +74,7 @@ src/dataunit/DataUnit.ts:1963
74
74
 
75
75
  #### Source
76
76
 
77
- src/dataunit/DataUnit.ts:1965
77
+ src/dataunit/DataUnit.ts:1971
78
78
 
79
79
  ***
80
80
 
@@ -84,7 +84,7 @@ src/dataunit/DataUnit.ts:1965
84
84
 
85
85
  #### Source
86
86
 
87
- src/dataunit/DataUnit.ts:1962
87
+ src/dataunit/DataUnit.ts:1968
88
88
 
89
89
  ***
90
90
 
@@ -94,7 +94,7 @@ src/dataunit/DataUnit.ts:1962
94
94
 
95
95
  #### Source
96
96
 
97
- src/dataunit/DataUnit.ts:1964
97
+ src/dataunit/DataUnit.ts:1970
98
98
 
99
99
  ## Accessors
100
100
 
@@ -108,7 +108,7 @@ src/dataunit/DataUnit.ts:1964
108
108
 
109
109
  #### Source
110
110
 
111
- src/dataunit/DataUnit.ts:1997
111
+ src/dataunit/DataUnit.ts:2003
112
112
 
113
113
  ***
114
114
 
@@ -122,7 +122,7 @@ src/dataunit/DataUnit.ts:1997
122
122
 
123
123
  #### Source
124
124
 
125
- src/dataunit/DataUnit.ts:1987
125
+ src/dataunit/DataUnit.ts:1993
126
126
 
127
127
  ***
128
128
 
@@ -136,7 +136,7 @@ src/dataunit/DataUnit.ts:1987
136
136
 
137
137
  #### Source
138
138
 
139
- src/dataunit/DataUnit.ts:1977
139
+ src/dataunit/DataUnit.ts:1983
140
140
 
141
141
  ## Methods
142
142
 
@@ -150,7 +150,7 @@ src/dataunit/DataUnit.ts:1977
150
150
 
151
151
  #### Source
152
152
 
153
- src/dataunit/DataUnit.ts:2004
153
+ src/dataunit/DataUnit.ts:2010
154
154
 
155
155
  ***
156
156
 
@@ -164,4 +164,4 @@ src/dataunit/DataUnit.ts:2004
164
164
 
165
165
  #### Source
166
166
 
167
- src/dataunit/DataUnit.ts:2008
167
+ src/dataunit/DataUnit.ts:2014
package/enumerations/Action.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/state/action/DataUnitAction.ts:52
17
+ src/dataunit/state/action/DataUnitAction.ts:53
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/state/action/DataUnitAction.ts:52
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/state/action/DataUnitAction.ts:51
27
+ src/dataunit/state/action/DataUnitAction.ts:52
28
28
 
29
29
  ***
30
30
 
@@ -34,7 +34,7 @@ src/dataunit/state/action/DataUnitAction.ts:51
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/state/action/DataUnitAction.ts:45
37
+ src/dataunit/state/action/DataUnitAction.ts:46
38
38
 
39
39
  ***
40
40
 
@@ -44,7 +44,7 @@ src/dataunit/state/action/DataUnitAction.ts:45
44
44
 
45
45
  #### Source
46
46
 
47
- src/dataunit/state/action/DataUnitAction.ts:63
47
+ src/dataunit/state/action/DataUnitAction.ts:64
48
48
 
49
49
  ***
50
50
 
@@ -54,7 +54,7 @@ src/dataunit/state/action/DataUnitAction.ts:63
54
54
 
55
55
  #### Source
56
56
 
57
- src/dataunit/state/action/DataUnitAction.ts:47
57
+ src/dataunit/state/action/DataUnitAction.ts:48
58
58
 
59
59
  ***
60
60
 
@@ -74,7 +74,7 @@ src/dataunit/state/action/DataUnitAction.ts:33
74
74
 
75
75
  #### Source
76
76
 
77
- src/dataunit/state/action/DataUnitAction.ts:48
77
+ src/dataunit/state/action/DataUnitAction.ts:49
78
78
 
79
79
  ***
80
80
 
@@ -94,7 +94,7 @@ src/dataunit/state/action/DataUnitAction.ts:37
94
94
 
95
95
  #### Source
96
96
 
97
- src/dataunit/state/action/DataUnitAction.ts:50
97
+ src/dataunit/state/action/DataUnitAction.ts:51
98
98
 
99
99
  ***
100
100
 
@@ -104,7 +104,7 @@ src/dataunit/state/action/DataUnitAction.ts:50
104
104
 
105
105
  #### Source
106
106
 
107
- src/dataunit/state/action/DataUnitAction.ts:65
107
+ src/dataunit/state/action/DataUnitAction.ts:66
108
108
 
109
109
  ***
110
110
 
@@ -114,7 +114,7 @@ src/dataunit/state/action/DataUnitAction.ts:65
114
114
 
115
115
  #### Source
116
116
 
117
- src/dataunit/state/action/DataUnitAction.ts:66
117
+ src/dataunit/state/action/DataUnitAction.ts:67
118
118
 
119
119
  ***
120
120
 
@@ -144,7 +144,7 @@ src/dataunit/state/action/DataUnitAction.ts:29
144
144
 
145
145
  #### Source
146
146
 
147
- src/dataunit/state/action/DataUnitAction.ts:69
147
+ src/dataunit/state/action/DataUnitAction.ts:70
148
148
 
149
149
  ***
150
150
 
@@ -154,7 +154,7 @@ src/dataunit/state/action/DataUnitAction.ts:69
154
154
 
155
155
  #### Source
156
156
 
157
- src/dataunit/state/action/DataUnitAction.ts:68
157
+ src/dataunit/state/action/DataUnitAction.ts:69
158
158
 
159
159
  ***
160
160
 
@@ -164,7 +164,7 @@ src/dataunit/state/action/DataUnitAction.ts:68
164
164
 
165
165
  #### Source
166
166
 
167
- src/dataunit/state/action/DataUnitAction.ts:60
167
+ src/dataunit/state/action/DataUnitAction.ts:61
168
168
 
169
169
  ***
170
170
 
@@ -184,7 +184,7 @@ src/dataunit/state/action/DataUnitAction.ts:30
184
184
 
185
185
  #### Source
186
186
 
187
- src/dataunit/state/action/DataUnitAction.ts:55
187
+ src/dataunit/state/action/DataUnitAction.ts:56
188
188
 
189
189
  ***
190
190
 
@@ -204,7 +204,7 @@ src/dataunit/state/action/DataUnitAction.ts:34
204
204
 
205
205
  #### Source
206
206
 
207
- src/dataunit/state/action/DataUnitAction.ts:56
207
+ src/dataunit/state/action/DataUnitAction.ts:57
208
208
 
209
209
  ***
210
210
 
@@ -214,7 +214,7 @@ src/dataunit/state/action/DataUnitAction.ts:56
214
214
 
215
215
  #### Source
216
216
 
217
- src/dataunit/state/action/DataUnitAction.ts:42
217
+ src/dataunit/state/action/DataUnitAction.ts:43
218
218
 
219
219
  ***
220
220
 
@@ -224,7 +224,7 @@ src/dataunit/state/action/DataUnitAction.ts:42
224
224
 
225
225
  #### Source
226
226
 
227
- src/dataunit/state/action/DataUnitAction.ts:43
227
+ src/dataunit/state/action/DataUnitAction.ts:44
228
228
 
229
229
  ***
230
230
 
@@ -234,7 +234,7 @@ src/dataunit/state/action/DataUnitAction.ts:43
234
234
 
235
235
  #### Source
236
236
 
237
- src/dataunit/state/action/DataUnitAction.ts:40
237
+ src/dataunit/state/action/DataUnitAction.ts:41
238
238
 
239
239
  ***
240
240
 
@@ -244,7 +244,7 @@ src/dataunit/state/action/DataUnitAction.ts:40
244
244
 
245
245
  #### Source
246
246
 
247
- src/dataunit/state/action/DataUnitAction.ts:61
247
+ src/dataunit/state/action/DataUnitAction.ts:62
248
248
 
249
249
  ***
250
250
 
@@ -254,7 +254,7 @@ src/dataunit/state/action/DataUnitAction.ts:61
254
254
 
255
255
  #### Source
256
256
 
257
- src/dataunit/state/action/DataUnitAction.ts:39
257
+ src/dataunit/state/action/DataUnitAction.ts:40
258
258
 
259
259
  ***
260
260
 
@@ -268,13 +268,23 @@ src/dataunit/state/action/DataUnitAction.ts:36
268
268
 
269
269
  ***
270
270
 
271
+ ### SAVING\_ERROR
272
+
273
+ > **SAVING\_ERROR**: `"savingError"`
274
+
275
+ #### Source
276
+
277
+ src/dataunit/state/action/DataUnitAction.ts:38
278
+
279
+ ***
280
+
271
281
  ### SELECTION\_CHANGED
272
282
 
273
283
  > **SELECTION\_CHANGED**: `"selectionChanged"`
274
284
 
275
285
  #### Source
276
286
 
277
- src/dataunit/state/action/DataUnitAction.ts:54
287
+ src/dataunit/state/action/DataUnitAction.ts:55
278
288
 
279
289
  ***
280
290
 
@@ -284,7 +294,7 @@ src/dataunit/state/action/DataUnitAction.ts:54
284
294
 
285
295
  #### Source
286
296
 
287
- src/dataunit/state/action/DataUnitAction.ts:58
297
+ src/dataunit/state/action/DataUnitAction.ts:59
288
298
 
289
299
  ***
290
300
 
@@ -294,4 +304,4 @@ src/dataunit/state/action/DataUnitAction.ts:58
294
304
 
295
305
  #### Source
296
306
 
297
- src/dataunit/state/action/DataUnitAction.ts:46
307
+ src/dataunit/state/action/DataUnitAction.ts:47
package/enumerations/ChangeOperation.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1848
17
+ src/dataunit/DataUnit.ts:1854
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1848
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1850
27
+ src/dataunit/DataUnit.ts:1856
28
28
 
29
29
  ***
30
30
 
@@ -34,7 +34,7 @@ src/dataunit/DataUnit.ts:1850
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1847
37
+ src/dataunit/DataUnit.ts:1853
38
38
 
39
39
  ***
40
40
 
@@ -44,4 +44,4 @@ src/dataunit/DataUnit.ts:1847
44
44
 
45
45
  #### Source
46
46
 
47
- src/dataunit/DataUnit.ts:1849
47
+ src/dataunit/DataUnit.ts:1855
package/enumerations/SelectionMode.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1956
17
+ src/dataunit/DataUnit.ts:1962
18
18
 
19
19
  ***
20
20
 
@@ -24,4 +24,4 @@ src/dataunit/DataUnit.ts:1956
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1957
27
+ src/dataunit/DataUnit.ts:1963
package/interfaces/DUActionInterceptor.md CHANGED
@@ -22,4 +22,4 @@
22
22
 
23
23
  #### Source
24
24
 
25
- src/dataunit/DataUnit.ts:1831
25
+ src/dataunit/DataUnit.ts:1837
package/interfaces/PageRequest.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1936
17
+ src/dataunit/DataUnit.ts:1942
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1936
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1937
27
+ src/dataunit/DataUnit.ts:1943
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1937
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1938
37
+ src/dataunit/DataUnit.ts:1944
package/interfaces/QuickFilter.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1943
17
+ src/dataunit/DataUnit.ts:1949
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1943
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1944
27
+ src/dataunit/DataUnit.ts:1950
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1944
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1942
37
+ src/dataunit/DataUnit.ts:1948
package/interfaces/Record.md CHANGED
@@ -22,7 +22,7 @@
22
22
 
23
23
  #### Source
24
24
 
25
- src/dataunit/DataUnit.ts:1838
25
+ src/dataunit/DataUnit.ts:1844
26
26
 
27
27
  ***
28
28
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1838
32
32
 
33
33
  #### Source
34
34
 
35
- src/dataunit/DataUnit.ts:1837
35
+ src/dataunit/DataUnit.ts:1843
36
36
 
37
37
  ***
38
38
 
@@ -42,7 +42,7 @@ src/dataunit/DataUnit.ts:1837
42
42
 
43
43
  #### Source
44
44
 
45
- src/dataunit/DataUnit.ts:1835
45
+ src/dataunit/DataUnit.ts:1841
46
46
 
47
47
  ***
48
48
 
@@ -52,4 +52,4 @@ src/dataunit/DataUnit.ts:1835
52
52
 
53
53
  #### Source
54
54
 
55
- src/dataunit/DataUnit.ts:1836
55
+ src/dataunit/DataUnit.ts:1842
package/interfaces/SavedRecord.md CHANGED
@@ -18,7 +18,7 @@
18
18
 
19
19
  #### Source
20
20
 
21
- src/dataunit/DataUnit.ts:1843
21
+ src/dataunit/DataUnit.ts:1849
22
22
 
23
23
  ***
24
24
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1843
32
32
 
33
33
  #### Source
34
34
 
35
- src/dataunit/DataUnit.ts:1838
35
+ src/dataunit/DataUnit.ts:1844
36
36
 
37
37
  ***
38
38
 
@@ -46,7 +46,7 @@ src/dataunit/DataUnit.ts:1838
46
46
 
47
47
  #### Source
48
48
 
49
- src/dataunit/DataUnit.ts:1837
49
+ src/dataunit/DataUnit.ts:1843
50
50
 
51
51
  ***
52
52
 
@@ -60,7 +60,7 @@ src/dataunit/DataUnit.ts:1837
60
60
 
61
61
  #### Source
62
62
 
63
- src/dataunit/DataUnit.ts:1835
63
+ src/dataunit/DataUnit.ts:1841
64
64
 
65
65
  ***
66
66
 
@@ -74,4 +74,4 @@ src/dataunit/DataUnit.ts:1835
74
74
 
75
75
  #### Source
76
76
 
77
- src/dataunit/DataUnit.ts:1836
77
+ src/dataunit/DataUnit.ts:1842
package/interfaces/WaitingChange.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1931
17
+ src/dataunit/DataUnit.ts:1937
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1931
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1932
27
+ src/dataunit/DataUnit.ts:1938
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1932
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1930
37
+ src/dataunit/DataUnit.ts:1936
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/core-docs",
3
- "version": "0.0.0-feat-dev-KB-60347.0",
3
+ "version": "0.0.0-feat-dev-KB-60347.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:2013
17
+ src/dataunit/DataUnit.ts:2019