@sankhyalabs/core-docs 5.20.0-rc.25 → 5.20.0-rc.27

Sign up to get free protection for your applications and to get access to all the features.
Files changed (16) hide show
  1. package/classes/Change.md +11 -11
  2. package/classes/DataUnit.md +201 -131
  3. package/classes/SelectionInfo.md +12 -12
  4. package/classes/ServiceCanceledException.md +193 -0
  5. package/enumerations/Action.md +32 -22
  6. package/enumerations/ChangeOperation.md +4 -4
  7. package/enumerations/SelectionMode.md +2 -2
  8. package/globals.md +1 -0
  9. package/interfaces/DUActionInterceptor.md +1 -1
  10. package/interfaces/PageRequest.md +3 -3
  11. package/interfaces/QuickFilter.md +3 -3
  12. package/interfaces/Record.md +4 -4
  13. package/interfaces/SavedRecord.md +5 -5
  14. package/interfaces/WaitingChange.md +3 -3
  15. package/package.json +1 -1
  16. package/type-aliases/DataUnitEventOptions.md +1 -1
package/classes/SelectionInfo.md CHANGED
@@ -30,7 +30,7 @@
30
30
 
31
31
  #### Source
32
32
 
33
- src/dataunit/DataUnit.ts:1975
33
+ src/dataunit/DataUnit.ts:2008
34
34
 
35
35
  ## Properties
36
36
 
@@ -40,7 +40,7 @@ src/dataunit/DataUnit.ts:1975
40
40
 
41
41
  #### Source
42
42
 
43
- src/dataunit/DataUnit.ts:1972
43
+ src/dataunit/DataUnit.ts:2005
44
44
 
45
45
  ***
46
46
 
@@ -50,7 +50,7 @@ src/dataunit/DataUnit.ts:1972
50
50
 
51
51
  #### Source
52
52
 
53
- src/dataunit/DataUnit.ts:1973
53
+ src/dataunit/DataUnit.ts:2006
54
54
 
55
55
  ***
56
56
 
@@ -60,7 +60,7 @@ src/dataunit/DataUnit.ts:1973
60
60
 
61
61
  #### Source
62
62
 
63
- src/dataunit/DataUnit.ts:1969
63
+ src/dataunit/DataUnit.ts:2002
64
64
 
65
65
  ***
66
66
 
@@ -74,7 +74,7 @@ src/dataunit/DataUnit.ts:1969
74
74
 
75
75
  #### Source
76
76
 
77
- src/dataunit/DataUnit.ts:1971
77
+ src/dataunit/DataUnit.ts:2004
78
78
 
79
79
  ***
80
80
 
@@ -84,7 +84,7 @@ src/dataunit/DataUnit.ts:1971
84
84
 
85
85
  #### Source
86
86
 
87
- src/dataunit/DataUnit.ts:1968
87
+ src/dataunit/DataUnit.ts:2001
88
88
 
89
89
  ***
90
90
 
@@ -94,7 +94,7 @@ src/dataunit/DataUnit.ts:1968
94
94
 
95
95
  #### Source
96
96
 
97
- src/dataunit/DataUnit.ts:1970
97
+ src/dataunit/DataUnit.ts:2003
98
98
 
99
99
  ## Accessors
100
100
 
@@ -108,7 +108,7 @@ src/dataunit/DataUnit.ts:1970
108
108
 
109
109
  #### Source
110
110
 
111
- src/dataunit/DataUnit.ts:2003
111
+ src/dataunit/DataUnit.ts:2036
112
112
 
113
113
  ***
114
114
 
@@ -122,7 +122,7 @@ src/dataunit/DataUnit.ts:2003
122
122
 
123
123
  #### Source
124
124
 
125
- src/dataunit/DataUnit.ts:1993
125
+ src/dataunit/DataUnit.ts:2026
126
126
 
127
127
  ***
128
128
 
@@ -136,7 +136,7 @@ src/dataunit/DataUnit.ts:1993
136
136
 
137
137
  #### Source
138
138
 
139
- src/dataunit/DataUnit.ts:1983
139
+ src/dataunit/DataUnit.ts:2016
140
140
 
141
141
  ## Methods
142
142
 
@@ -150,7 +150,7 @@ src/dataunit/DataUnit.ts:1983
150
150
 
151
151
  #### Source
152
152
 
153
- src/dataunit/DataUnit.ts:2010
153
+ src/dataunit/DataUnit.ts:2043
154
154
 
155
155
  ***
156
156
 
@@ -164,4 +164,4 @@ src/dataunit/DataUnit.ts:2010
164
164
 
165
165
  #### Source
166
166
 
167
- src/dataunit/DataUnit.ts:2014
167
+ src/dataunit/DataUnit.ts:2047
package/classes/ServiceCanceledException.md ADDED
@@ -0,0 +1,193 @@
1
+ [**@sankhyalabs/core**](../README.md) • **Docs**
2
+
3
+ ***
4
+
5
+ [@sankhyalabs/core](../globals.md) / ServiceCanceledException
6
+
7
+ # Class: ServiceCanceledException
8
+
9
+ `ServiceCanceledException`: Exceção lançada quando ocorre o cancelamento de um serviço.
10
+
11
+ ## Extends
12
+
13
+ - `Error`
14
+
15
+ ## Constructors
16
+
17
+ ### new ServiceCanceledException()
18
+
19
+ > **new ServiceCanceledException**(`title`, `message`, `errorCode`): [`ServiceCanceledException`](ServiceCanceledException.md)
20
+
21
+ #### Parameters
22
+
23
+ • **title**: `string`
24
+
25
+ • **message**: `string`
26
+
27
+ • **errorCode**: `string`= `""`
28
+
29
+ #### Returns
30
+
31
+ [`ServiceCanceledException`](ServiceCanceledException.md)
32
+
33
+ #### Overrides
34
+
35
+ `Error.constructor`
36
+
37
+ #### Source
38
+
39
+ src/exceptions/ServiceCanceledException.ts:18
40
+
41
+ ## Properties
42
+
43
+ ### cause?
44
+
45
+ > `optional` **cause**: `unknown`
46
+
47
+ #### Inherited from
48
+
49
+ `Error.cause`
50
+
51
+ #### Source
52
+
53
+ node\_modules/typescript/lib/lib.es2022.error.d.ts:26
54
+
55
+ ***
56
+
57
+ ### errorCode
58
+
59
+ > **errorCode**: `string`
60
+
61
+ Código do erro, indica o erro disparado pelo backend.
62
+
63
+ #### Source
64
+
65
+ src/exceptions/ServiceCanceledException.ts:16
66
+
67
+ ***
68
+
69
+ ### message
70
+
71
+ > **message**: `string`
72
+
73
+ Descrição do erro.
74
+
75
+ #### Overrides
76
+
77
+ `Error.message`
78
+
79
+ #### Source
80
+
81
+ src/exceptions/ServiceCanceledException.ts:13
82
+
83
+ ***
84
+
85
+ ### name
86
+
87
+ > **name**: `string`
88
+
89
+ Nome da exceção.
90
+
91
+ #### Overrides
92
+
93
+ `Error.name`
94
+
95
+ #### Source
96
+
97
+ src/exceptions/ServiceCanceledException.ts:7
98
+
99
+ ***
100
+
101
+ ### stack?
102
+
103
+ > `optional` **stack**: `string`
104
+
105
+ #### Inherited from
106
+
107
+ `Error.stack`
108
+
109
+ #### Source
110
+
111
+ node\_modules/typescript/lib/lib.es5.d.ts:1055
112
+
113
+ ***
114
+
115
+ ### title
116
+
117
+ > **title**: `string`
118
+
119
+ Titulo do erro.
120
+
121
+ #### Source
122
+
123
+ src/exceptions/ServiceCanceledException.ts:10
124
+
125
+ ***
126
+
127
+ ### prepareStackTrace()?
128
+
129
+ > `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any`
130
+
131
+ Optional override for formatting stack traces
132
+
133
+ #### See
134
+
135
+ https://v8.dev/docs/stack-trace-api#customizing-stack-traces
136
+
137
+ #### Parameters
138
+
139
+ • **err**: `Error`
140
+
141
+ • **stackTraces**: `CallSite`[]
142
+
143
+ #### Returns
144
+
145
+ `any`
146
+
147
+ #### Inherited from
148
+
149
+ `Error.prepareStackTrace`
150
+
151
+ #### Source
152
+
153
+ node\_modules/@types/node/globals.d.ts:27
154
+
155
+ ***
156
+
157
+ ### stackTraceLimit
158
+
159
+ > `static` **stackTraceLimit**: `number`
160
+
161
+ #### Inherited from
162
+
163
+ `Error.stackTraceLimit`
164
+
165
+ #### Source
166
+
167
+ node\_modules/@types/node/globals.d.ts:29
168
+
169
+ ## Methods
170
+
171
+ ### captureStackTrace()
172
+
173
+ > `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void`
174
+
175
+ Create .stack property on a target object
176
+
177
+ #### Parameters
178
+
179
+ • **targetObject**: `object`
180
+
181
+ • **constructorOpt?**: `Function`
182
+
183
+ #### Returns
184
+
185
+ `void`
186
+
187
+ #### Inherited from
188
+
189
+ `Error.captureStackTrace`
190
+
191
+ #### Source
192
+
193
+ node\_modules/@types/node/globals.d.ts:20
package/enumerations/Action.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/state/action/DataUnitAction.ts:53
17
+ src/dataunit/state/action/DataUnitAction.ts:54
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/state/action/DataUnitAction.ts:53
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/state/action/DataUnitAction.ts:52
27
+ src/dataunit/state/action/DataUnitAction.ts:53
28
28
 
29
29
  ***
30
30
 
@@ -34,7 +34,7 @@ src/dataunit/state/action/DataUnitAction.ts:52
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/state/action/DataUnitAction.ts:46
37
+ src/dataunit/state/action/DataUnitAction.ts:47
38
38
 
39
39
  ***
40
40
 
@@ -44,7 +44,7 @@ src/dataunit/state/action/DataUnitAction.ts:46
44
44
 
45
45
  #### Source
46
46
 
47
- src/dataunit/state/action/DataUnitAction.ts:64
47
+ src/dataunit/state/action/DataUnitAction.ts:65
48
48
 
49
49
  ***
50
50
 
@@ -54,7 +54,7 @@ src/dataunit/state/action/DataUnitAction.ts:64
54
54
 
55
55
  #### Source
56
56
 
57
- src/dataunit/state/action/DataUnitAction.ts:48
57
+ src/dataunit/state/action/DataUnitAction.ts:49
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:49
77
+ src/dataunit/state/action/DataUnitAction.ts:50
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:51
97
+ src/dataunit/state/action/DataUnitAction.ts:52
98
98
 
99
99
  ***
100
100
 
@@ -104,7 +104,7 @@ src/dataunit/state/action/DataUnitAction.ts:51
104
104
 
105
105
  #### Source
106
106
 
107
- src/dataunit/state/action/DataUnitAction.ts:66
107
+ src/dataunit/state/action/DataUnitAction.ts:67
108
108
 
109
109
  ***
110
110
 
@@ -114,7 +114,7 @@ src/dataunit/state/action/DataUnitAction.ts:66
114
114
 
115
115
  #### Source
116
116
 
117
- src/dataunit/state/action/DataUnitAction.ts:67
117
+ src/dataunit/state/action/DataUnitAction.ts:68
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:70
147
+ src/dataunit/state/action/DataUnitAction.ts:71
148
148
 
149
149
  ***
150
150
 
@@ -154,7 +154,7 @@ src/dataunit/state/action/DataUnitAction.ts:70
154
154
 
155
155
  #### Source
156
156
 
157
- src/dataunit/state/action/DataUnitAction.ts:69
157
+ src/dataunit/state/action/DataUnitAction.ts:70
158
158
 
159
159
  ***
160
160
 
@@ -164,7 +164,7 @@ src/dataunit/state/action/DataUnitAction.ts:69
164
164
 
165
165
  #### Source
166
166
 
167
- src/dataunit/state/action/DataUnitAction.ts:61
167
+ src/dataunit/state/action/DataUnitAction.ts:62
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:56
187
+ src/dataunit/state/action/DataUnitAction.ts:57
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:57
207
+ src/dataunit/state/action/DataUnitAction.ts:58
208
208
 
209
209
  ***
210
210
 
@@ -214,7 +214,7 @@ src/dataunit/state/action/DataUnitAction.ts:57
214
214
 
215
215
  #### Source
216
216
 
217
- src/dataunit/state/action/DataUnitAction.ts:43
217
+ src/dataunit/state/action/DataUnitAction.ts:44
218
218
 
219
219
  ***
220
220
 
@@ -224,7 +224,7 @@ src/dataunit/state/action/DataUnitAction.ts:43
224
224
 
225
225
  #### Source
226
226
 
227
- src/dataunit/state/action/DataUnitAction.ts:44
227
+ src/dataunit/state/action/DataUnitAction.ts:45
228
228
 
229
229
  ***
230
230
 
@@ -234,7 +234,7 @@ src/dataunit/state/action/DataUnitAction.ts:44
234
234
 
235
235
  #### Source
236
236
 
237
- src/dataunit/state/action/DataUnitAction.ts:41
237
+ src/dataunit/state/action/DataUnitAction.ts:42
238
238
 
239
239
  ***
240
240
 
@@ -244,7 +244,7 @@ src/dataunit/state/action/DataUnitAction.ts:41
244
244
 
245
245
  #### Source
246
246
 
247
- src/dataunit/state/action/DataUnitAction.ts:62
247
+ src/dataunit/state/action/DataUnitAction.ts:63
248
248
 
249
249
  ***
250
250
 
@@ -254,7 +254,17 @@ src/dataunit/state/action/DataUnitAction.ts:62
254
254
 
255
255
  #### Source
256
256
 
257
- src/dataunit/state/action/DataUnitAction.ts:40
257
+ src/dataunit/state/action/DataUnitAction.ts:41
258
+
259
+ ***
260
+
261
+ ### SAVING\_CANCELED
262
+
263
+ > **SAVING\_CANCELED**: `"savingCanceled"`
264
+
265
+ #### Source
266
+
267
+ src/dataunit/state/action/DataUnitAction.ts:39
258
268
 
259
269
  ***
260
270
 
@@ -284,7 +294,7 @@ src/dataunit/state/action/DataUnitAction.ts:38
284
294
 
285
295
  #### Source
286
296
 
287
- src/dataunit/state/action/DataUnitAction.ts:55
297
+ src/dataunit/state/action/DataUnitAction.ts:56
288
298
 
289
299
  ***
290
300
 
@@ -294,7 +304,7 @@ src/dataunit/state/action/DataUnitAction.ts:55
294
304
 
295
305
  #### Source
296
306
 
297
- src/dataunit/state/action/DataUnitAction.ts:59
307
+ src/dataunit/state/action/DataUnitAction.ts:60
298
308
 
299
309
  ***
300
310
 
@@ -304,4 +314,4 @@ src/dataunit/state/action/DataUnitAction.ts:59
304
314
 
305
315
  #### Source
306
316
 
307
- src/dataunit/state/action/DataUnitAction.ts:47
317
+ src/dataunit/state/action/DataUnitAction.ts:48
package/enumerations/ChangeOperation.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1854
17
+ src/dataunit/DataUnit.ts:1887
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1854
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1856
27
+ src/dataunit/DataUnit.ts:1889
28
28
 
29
29
  ***
30
30
 
@@ -34,7 +34,7 @@ src/dataunit/DataUnit.ts:1856
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1853
37
+ src/dataunit/DataUnit.ts:1886
38
38
 
39
39
  ***
40
40
 
@@ -44,4 +44,4 @@ src/dataunit/DataUnit.ts:1853
44
44
 
45
45
  #### Source
46
46
 
47
- src/dataunit/DataUnit.ts:1855
47
+ src/dataunit/DataUnit.ts:1888
package/enumerations/SelectionMode.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1962
17
+ src/dataunit/DataUnit.ts:1995
18
18
 
19
19
  ***
20
20
 
@@ -24,4 +24,4 @@ src/dataunit/DataUnit.ts:1962
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1963
27
+ src/dataunit/DataUnit.ts:1996
package/globals.md CHANGED
@@ -49,6 +49,7 @@
49
49
  - [RequestMetadata](classes/RequestMetadata.md)
50
50
  - [SearchUtils](classes/SearchUtils.md)
51
51
  - [SelectionInfo](classes/SelectionInfo.md)
52
+ - [ServiceCanceledException](classes/ServiceCanceledException.md)
52
53
  - [SkwHttpProvider](classes/SkwHttpProvider.md)
53
54
  - [StringUtils](classes/StringUtils.md)
54
55
  - [TimeFormatter](classes/TimeFormatter.md)
package/interfaces/DUActionInterceptor.md CHANGED
@@ -22,4 +22,4 @@
22
22
 
23
23
  #### Source
24
24
 
25
- src/dataunit/DataUnit.ts:1837
25
+ src/dataunit/DataUnit.ts:1870
package/interfaces/PageRequest.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1942
17
+ src/dataunit/DataUnit.ts:1975
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1942
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1943
27
+ src/dataunit/DataUnit.ts:1976
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1943
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1944
37
+ src/dataunit/DataUnit.ts:1977
package/interfaces/QuickFilter.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1949
17
+ src/dataunit/DataUnit.ts:1982
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1949
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1950
27
+ src/dataunit/DataUnit.ts:1983
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1950
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1948
37
+ src/dataunit/DataUnit.ts:1981
package/interfaces/Record.md CHANGED
@@ -22,7 +22,7 @@
22
22
 
23
23
  #### Source
24
24
 
25
- src/dataunit/DataUnit.ts:1844
25
+ src/dataunit/DataUnit.ts:1877
26
26
 
27
27
  ***
28
28
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1844
32
32
 
33
33
  #### Source
34
34
 
35
- src/dataunit/DataUnit.ts:1843
35
+ src/dataunit/DataUnit.ts:1876
36
36
 
37
37
  ***
38
38
 
@@ -42,7 +42,7 @@ src/dataunit/DataUnit.ts:1843
42
42
 
43
43
  #### Source
44
44
 
45
- src/dataunit/DataUnit.ts:1841
45
+ src/dataunit/DataUnit.ts:1874
46
46
 
47
47
  ***
48
48
 
@@ -52,4 +52,4 @@ src/dataunit/DataUnit.ts:1841
52
52
 
53
53
  #### Source
54
54
 
55
- src/dataunit/DataUnit.ts:1842
55
+ src/dataunit/DataUnit.ts:1875
package/interfaces/SavedRecord.md CHANGED
@@ -18,7 +18,7 @@
18
18
 
19
19
  #### Source
20
20
 
21
- src/dataunit/DataUnit.ts:1849
21
+ src/dataunit/DataUnit.ts:1882
22
22
 
23
23
  ***
24
24
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1849
32
32
 
33
33
  #### Source
34
34
 
35
- src/dataunit/DataUnit.ts:1844
35
+ src/dataunit/DataUnit.ts:1877
36
36
 
37
37
  ***
38
38
 
@@ -46,7 +46,7 @@ src/dataunit/DataUnit.ts:1844
46
46
 
47
47
  #### Source
48
48
 
49
- src/dataunit/DataUnit.ts:1843
49
+ src/dataunit/DataUnit.ts:1876
50
50
 
51
51
  ***
52
52
 
@@ -60,7 +60,7 @@ src/dataunit/DataUnit.ts:1843
60
60
 
61
61
  #### Source
62
62
 
63
- src/dataunit/DataUnit.ts:1841
63
+ src/dataunit/DataUnit.ts:1874
64
64
 
65
65
  ***
66
66
 
@@ -74,4 +74,4 @@ src/dataunit/DataUnit.ts:1841
74
74
 
75
75
  #### Source
76
76
 
77
- src/dataunit/DataUnit.ts:1842
77
+ src/dataunit/DataUnit.ts:1875
package/interfaces/WaitingChange.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1937
17
+ src/dataunit/DataUnit.ts:1970
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1937
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1938
27
+ src/dataunit/DataUnit.ts:1971
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1938
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1936
37
+ src/dataunit/DataUnit.ts:1969
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/core-docs",
3
- "version": "5.20.0-rc.25",
3
+ "version": "5.20.0-rc.27",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [