@sankhyalabs/core-docs 5.17.3 → 5.17.4

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 +129 -129
  3. package/classes/SelectionInfo.md +11 -11
  4. package/classes/ServiceCanceledException.md +193 -0
  5. package/enumerations/ChangeOperation.md +4 -4
  6. package/enumerations/SelectionMode.md +2 -2
  7. package/globals.md +1 -0
  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/SelectionInfo.md CHANGED
@@ -30,7 +30,7 @@
30
30
 
31
31
  #### Source
32
32
 
33
- src/dataunit/DataUnit.ts:1952
33
+ src/dataunit/DataUnit.ts:1958
34
34
 
35
35
  ## Properties
36
36
 
@@ -40,7 +40,7 @@ src/dataunit/DataUnit.ts:1952
40
40
 
41
41
  #### Source
42
42
 
43
- src/dataunit/DataUnit.ts:1946
43
+ src/dataunit/DataUnit.ts:1952
44
44
 
45
45
  ***
46
46
 
@@ -50,7 +50,7 @@ src/dataunit/DataUnit.ts:1946
50
50
 
51
51
  #### Source
52
52
 
53
- src/dataunit/DataUnit.ts:1948
53
+ src/dataunit/DataUnit.ts:1954
54
54
 
55
55
  ***
56
56
 
@@ -60,7 +60,7 @@ src/dataunit/DataUnit.ts:1948
60
60
 
61
61
  #### Source
62
62
 
63
- src/dataunit/DataUnit.ts:1949
63
+ src/dataunit/DataUnit.ts:1955
64
64
 
65
65
  ***
66
66
 
@@ -70,7 +70,7 @@ src/dataunit/DataUnit.ts:1949
70
70
 
71
71
  #### Source
72
72
 
73
- src/dataunit/DataUnit.ts:1947
73
+ src/dataunit/DataUnit.ts:1953
74
74
 
75
75
  ***
76
76
 
@@ -80,7 +80,7 @@ src/dataunit/DataUnit.ts:1947
80
80
 
81
81
  #### Source
82
82
 
83
- src/dataunit/DataUnit.ts:1950
83
+ src/dataunit/DataUnit.ts:1956
84
84
 
85
85
  ## Accessors
86
86
 
@@ -94,7 +94,7 @@ src/dataunit/DataUnit.ts:1950
94
94
 
95
95
  #### Source
96
96
 
97
- src/dataunit/DataUnit.ts:1977
97
+ src/dataunit/DataUnit.ts:1983
98
98
 
99
99
  ***
100
100
 
@@ -108,7 +108,7 @@ src/dataunit/DataUnit.ts:1977
108
108
 
109
109
  #### Source
110
110
 
111
- src/dataunit/DataUnit.ts:1967
111
+ src/dataunit/DataUnit.ts:1973
112
112
 
113
113
  ***
114
114
 
@@ -122,7 +122,7 @@ src/dataunit/DataUnit.ts:1967
122
122
 
123
123
  #### Source
124
124
 
125
- src/dataunit/DataUnit.ts:1960
125
+ src/dataunit/DataUnit.ts:1966
126
126
 
127
127
  ## Methods
128
128
 
@@ -136,7 +136,7 @@ src/dataunit/DataUnit.ts:1960
136
136
 
137
137
  #### Source
138
138
 
139
- src/dataunit/DataUnit.ts:1984
139
+ src/dataunit/DataUnit.ts:1990
140
140
 
141
141
  ***
142
142
 
@@ -150,4 +150,4 @@ src/dataunit/DataUnit.ts:1984
150
150
 
151
151
  #### Source
152
152
 
153
- src/dataunit/DataUnit.ts:1988
153
+ src/dataunit/DataUnit.ts:1994
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/ChangeOperation.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1832
17
+ src/dataunit/DataUnit.ts:1838
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1832
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1834
27
+ src/dataunit/DataUnit.ts:1840
28
28
 
29
29
  ***
30
30
 
@@ -34,7 +34,7 @@ src/dataunit/DataUnit.ts:1834
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1831
37
+ src/dataunit/DataUnit.ts:1837
38
38
 
39
39
  ***
40
40
 
@@ -44,4 +44,4 @@ src/dataunit/DataUnit.ts:1831
44
44
 
45
45
  #### Source
46
46
 
47
- src/dataunit/DataUnit.ts:1833
47
+ src/dataunit/DataUnit.ts:1839
package/enumerations/SelectionMode.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1940
17
+ src/dataunit/DataUnit.ts:1946
18
18
 
19
19
  ***
20
20
 
@@ -24,4 +24,4 @@ src/dataunit/DataUnit.ts:1940
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1941
27
+ src/dataunit/DataUnit.ts:1947
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:1815
25
+ src/dataunit/DataUnit.ts:1821
package/interfaces/PageRequest.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1920
17
+ src/dataunit/DataUnit.ts:1926
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1920
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1921
27
+ src/dataunit/DataUnit.ts:1927
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1921
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1922
37
+ src/dataunit/DataUnit.ts:1928
package/interfaces/QuickFilter.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1927
17
+ src/dataunit/DataUnit.ts:1933
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1927
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1928
27
+ src/dataunit/DataUnit.ts:1934
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1928
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1926
37
+ src/dataunit/DataUnit.ts:1932
package/interfaces/Record.md CHANGED
@@ -22,7 +22,7 @@
22
22
 
23
23
  #### Source
24
24
 
25
- src/dataunit/DataUnit.ts:1822
25
+ src/dataunit/DataUnit.ts:1828
26
26
 
27
27
  ***
28
28
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1822
32
32
 
33
33
  #### Source
34
34
 
35
- src/dataunit/DataUnit.ts:1821
35
+ src/dataunit/DataUnit.ts:1827
36
36
 
37
37
  ***
38
38
 
@@ -42,7 +42,7 @@ src/dataunit/DataUnit.ts:1821
42
42
 
43
43
  #### Source
44
44
 
45
- src/dataunit/DataUnit.ts:1819
45
+ src/dataunit/DataUnit.ts:1825
46
46
 
47
47
  ***
48
48
 
@@ -52,4 +52,4 @@ src/dataunit/DataUnit.ts:1819
52
52
 
53
53
  #### Source
54
54
 
55
- src/dataunit/DataUnit.ts:1820
55
+ src/dataunit/DataUnit.ts:1826
package/interfaces/SavedRecord.md CHANGED
@@ -18,7 +18,7 @@
18
18
 
19
19
  #### Source
20
20
 
21
- src/dataunit/DataUnit.ts:1827
21
+ src/dataunit/DataUnit.ts:1833
22
22
 
23
23
  ***
24
24
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1827
32
32
 
33
33
  #### Source
34
34
 
35
- src/dataunit/DataUnit.ts:1822
35
+ src/dataunit/DataUnit.ts:1828
36
36
 
37
37
  ***
38
38
 
@@ -46,7 +46,7 @@ src/dataunit/DataUnit.ts:1822
46
46
 
47
47
  #### Source
48
48
 
49
- src/dataunit/DataUnit.ts:1821
49
+ src/dataunit/DataUnit.ts:1827
50
50
 
51
51
  ***
52
52
 
@@ -60,7 +60,7 @@ src/dataunit/DataUnit.ts:1821
60
60
 
61
61
  #### Source
62
62
 
63
- src/dataunit/DataUnit.ts:1819
63
+ src/dataunit/DataUnit.ts:1825
64
64
 
65
65
  ***
66
66
 
@@ -74,4 +74,4 @@ src/dataunit/DataUnit.ts:1819
74
74
 
75
75
  #### Source
76
76
 
77
- src/dataunit/DataUnit.ts:1820
77
+ src/dataunit/DataUnit.ts:1826
package/interfaces/WaitingChange.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1915
17
+ src/dataunit/DataUnit.ts:1921
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1915
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1916
27
+ src/dataunit/DataUnit.ts:1922
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1916
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1914
37
+ src/dataunit/DataUnit.ts:1920
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/core-docs",
3
- "version": "5.17.3",
3
+ "version": "5.17.4",
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:1993
17
+ src/dataunit/DataUnit.ts:1999