@sankhyalabs/core-docs 5.20.0-dev.7 → 5.20.0-dev.70

Sign up to get free protection for your applications and to get access to all the features.
Files changed (43) hide show
  1. package/classes/Change.md +11 -11
  2. package/classes/ColumnFilterManager.md +145 -0
  3. package/classes/DataUnit.md +405 -137
  4. package/classes/DataUnitInMemoryLoader.md +303 -0
  5. package/classes/DataUnitLoaderUtils.md +151 -0
  6. package/classes/DateUtils.md +8 -8
  7. package/classes/FieldComparator.md +2 -2
  8. package/classes/IDBRepository.md +22 -0
  9. package/classes/LockManager.md +249 -0
  10. package/classes/MaskFormatter.md +66 -14
  11. package/classes/ObjectUtils.md +141 -0
  12. package/classes/OverflowWatcher.md +533 -0
  13. package/classes/SelectionInfo.md +25 -11
  14. package/classes/ServiceCanceledException.md +193 -0
  15. package/classes/ServiceUtils.md +67 -0
  16. package/classes/SilentException.md +193 -0
  17. package/classes/UserAgentUtils.md +15 -1
  18. package/enumerations/Action.md +41 -21
  19. package/enumerations/ChangeOperation.md +4 -4
  20. package/enumerations/LockManagerOperation.md +33 -0
  21. package/enumerations/OverflowDirection.md +29 -0
  22. package/enumerations/RECORD_DATE_FORMAT.md +27 -0
  23. package/enumerations/SelectionMode.md +2 -2
  24. package/enumerations/StorageType.md +37 -0
  25. package/globals.md +24 -0
  26. package/interfaces/DUActionInterceptor.md +1 -1
  27. package/interfaces/DataUnitInMemoryLoaderConfig.md +37 -0
  28. package/interfaces/IRepository.md +18 -0
  29. package/interfaces/LoadDataRequest.md +1 -1
  30. package/interfaces/OverFlowWatcherParams.md +67 -0
  31. package/interfaces/PageRequest.md +3 -3
  32. package/interfaces/PaginationInfo.md +25 -0
  33. package/interfaces/PaginationInfoBuilderParams.md +37 -0
  34. package/interfaces/QuickFilter.md +3 -3
  35. package/interfaces/Record.md +4 -4
  36. package/interfaces/SavedRecord.md +5 -5
  37. package/interfaces/WaitingChange.md +3 -3
  38. package/namespaces/MaskFormatter/type-aliases/MaskCharacter.md +1 -1
  39. package/namespaces/MaskFormatter/variables/MaskCharacter.md +1 -1
  40. package/package.json +1 -1
  41. package/type-aliases/DataUnitEventOptions.md +17 -0
  42. package/type-aliases/OnOverflowCallBack.md +25 -0
  43. package/variables/OVERFLOWED_CLASS_NAME.md +13 -0
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/classes/ServiceUtils.md ADDED
@@ -0,0 +1,67 @@
1
+ [**@sankhyalabs/core**](../README.md) • **Docs**
2
+
3
+ ***
4
+
5
+ [@sankhyalabs/core](../globals.md) / ServiceUtils
6
+
7
+ # Class: ServiceUtils
8
+
9
+ ## Constructors
10
+
11
+ ### new ServiceUtils()
12
+
13
+ > **new ServiceUtils**(): [`ServiceUtils`](ServiceUtils.md)
14
+
15
+ #### Returns
16
+
17
+ [`ServiceUtils`](ServiceUtils.md)
18
+
19
+ ## Methods
20
+
21
+ ### useCacheWithService()
22
+
23
+ > `static` **useCacheWithService**\<`T`\>(`identifier`, `fetchFunction`, `storageType`): `Promise`\<`T`\>
24
+
25
+ Auxilia no uso do CacheManager, gerando automaticamente uma chave de cache com base no identificador.
26
+
27
+ #### Type parameters
28
+
29
+ • **T**
30
+
31
+ Tipo do dado a ser retornado.
32
+
33
+ #### Parameters
34
+
35
+ • **identifier**: `string`
36
+
37
+ Identificadores únicos usados para compor a chave de cache.
38
+
39
+ • **fetchFunction**
40
+
41
+ Função que retorna uma `Promise` com o valor a ser armazenado no cache caso ele não exista ou tenha expirado.
42
+
43
+ • **storageType**: [`StorageType`](../enumerations/StorageType.md)= `StorageType.IN_MEMORY_CACHE`
44
+
45
+ Tipo de armazenamento: `'sessionStorage'` ou `'localStorage'`. O padrão é `'sessionStorage'`.
46
+
47
+ #### Returns
48
+
49
+ `Promise`\<`T`\>
50
+
51
+ Uma `Promise` com o valor armazenado ou obtido via `fetchFunction`.
52
+
53
+ #### Example
54
+
55
+ ```typescript
56
+ const actions = await useCacheWithService(
57
+ `${this.entityName} - ${this.resourceID}`,
58
+ async () => {
59
+ return await fetchActionsFromAPI();
60
+ }
61
+ );
62
+ console.log(actions);
63
+ ```
64
+
65
+ #### Source
66
+
67
+ src/utils/ServiceUtils.ts:28
package/classes/SilentException.md ADDED
@@ -0,0 +1,193 @@
1
+ [**@sankhyalabs/core**](../README.md) • **Docs**
2
+
3
+ ***
4
+
5
+ [@sankhyalabs/core](../globals.md) / SilentException
6
+
7
+ # Class: SilentException
8
+
9
+ `SilentException`: Exceção lançada quando uma exception silenciosa é.
10
+
11
+ ## Extends
12
+
13
+ - `Error`
14
+
15
+ ## Constructors
16
+
17
+ ### new SilentException()
18
+
19
+ > **new SilentException**(`title`, `message`, `errorCode`): [`SilentException`](SilentException.md)
20
+
21
+ #### Parameters
22
+
23
+ • **title**: `string`= `""`
24
+
25
+ • **message**: `string`= `""`
26
+
27
+ • **errorCode**: `string`= `""`
28
+
29
+ #### Returns
30
+
31
+ [`SilentException`](SilentException.md)
32
+
33
+ #### Overrides
34
+
35
+ `Error.constructor`
36
+
37
+ #### Source
38
+
39
+ src/exceptions/SilentException.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/SilentException.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/SilentException.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/SilentException.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/SilentException.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/classes/UserAgentUtils.md CHANGED
@@ -34,7 +34,21 @@ Objeto com o nome e versão do navegador.
34
34
 
35
35
  #### Source
36
36
 
37
- src/utils/UserAgentUtils/index.ts:22
37
+ src/utils/UserAgentUtils/index.ts:27
38
+
39
+ ***
40
+
41
+ ### isElectron()
42
+
43
+ > `static` **isElectron**(): `boolean`
44
+
45
+ #### Returns
46
+
47
+ `boolean`
48
+
49
+ #### Source
50
+
51
+ src/utils/UserAgentUtils/index.ts:18
38
52
 
39
53
  ***
40
54
 
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:54
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:53
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:47
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:65
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: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:48
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:50
97
+ src/dataunit/state/action/DataUnitAction.ts:52
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:67
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: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:69
147
+ src/dataunit/state/action/DataUnitAction.ts:71
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:70
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: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:55
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:56
207
+ src/dataunit/state/action/DataUnitAction.ts:58
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:44
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:45
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:42
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:63
248
248
 
249
249
  ***
250
250
 
@@ -254,6 +254,16 @@ src/dataunit/state/action/DataUnitAction.ts:61
254
254
 
255
255
  #### Source
256
256
 
257
+ src/dataunit/state/action/DataUnitAction.ts:41
258
+
259
+ ***
260
+
261
+ ### SAVING\_CANCELED
262
+
263
+ > **SAVING\_CANCELED**: `"savingCanceled"`
264
+
265
+ #### Source
266
+
257
267
  src/dataunit/state/action/DataUnitAction.ts:39
258
268
 
259
269
  ***
@@ -268,13 +278,23 @@ src/dataunit/state/action/DataUnitAction.ts:36
268
278
 
269
279
  ***
270
280
 
281
+ ### SAVING\_ERROR
282
+
283
+ > **SAVING\_ERROR**: `"savingError"`
284
+
285
+ #### Source
286
+
287
+ src/dataunit/state/action/DataUnitAction.ts:38
288
+
289
+ ***
290
+
271
291
  ### SELECTION\_CHANGED
272
292
 
273
293
  > **SELECTION\_CHANGED**: `"selectionChanged"`
274
294
 
275
295
  #### Source
276
296
 
277
- src/dataunit/state/action/DataUnitAction.ts:54
297
+ src/dataunit/state/action/DataUnitAction.ts:56
278
298
 
279
299
  ***
280
300
 
@@ -284,7 +304,7 @@ src/dataunit/state/action/DataUnitAction.ts:54
284
304
 
285
305
  #### Source
286
306
 
287
- src/dataunit/state/action/DataUnitAction.ts:58
307
+ src/dataunit/state/action/DataUnitAction.ts:60
288
308
 
289
309
  ***
290
310
 
@@ -294,4 +314,4 @@ src/dataunit/state/action/DataUnitAction.ts:58
294
314
 
295
315
  #### Source
296
316
 
297
- src/dataunit/state/action/DataUnitAction.ts:46
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:1795
17
+ src/dataunit/DataUnit.ts:1953
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1795
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1797
27
+ src/dataunit/DataUnit.ts:1955
28
28
 
29
29
  ***
30
30
 
@@ -34,7 +34,7 @@ src/dataunit/DataUnit.ts:1797
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1794
37
+ src/dataunit/DataUnit.ts:1952
38
38
 
39
39
  ***
40
40
 
@@ -44,4 +44,4 @@ src/dataunit/DataUnit.ts:1794
44
44
 
45
45
  #### Source
46
46
 
47
- src/dataunit/DataUnit.ts:1796
47
+ src/dataunit/DataUnit.ts:1954