@sankhyalabs/core-docs 5.20.0-dev.8 → 5.20.0-dev.80

Sign up to get free protection for your applications and to get access to all the features.
Files changed (47) hide show
  1. package/classes/Base64Utils.md +39 -0
  2. package/classes/Change.md +11 -11
  3. package/classes/ColumnFilterManager.md +145 -0
  4. package/classes/DataUnit.md +429 -139
  5. package/classes/DataUnitInMemoryLoader.md +303 -0
  6. package/classes/DataUnitLoaderUtils.md +151 -0
  7. package/classes/DateUtils.md +8 -8
  8. package/classes/FieldComparator.md +2 -2
  9. package/classes/IDBRepository.md +22 -0
  10. package/classes/KeyboardManager.md +99 -9
  11. package/classes/LockManager.md +249 -0
  12. package/classes/MaskFormatter.md +66 -14
  13. package/classes/ObjectUtils.md +189 -0
  14. package/classes/OverflowWatcher.md +533 -0
  15. package/classes/SelectionInfo.md +25 -11
  16. package/classes/ServiceCanceledException.md +193 -0
  17. package/classes/ServiceUtils.md +67 -0
  18. package/classes/SilentException.md +193 -0
  19. package/classes/StringUtils.md +33 -9
  20. package/classes/UserAgentUtils.md +15 -1
  21. package/enumerations/Action.md +41 -21
  22. package/enumerations/ChangeOperation.md +4 -4
  23. package/enumerations/LockManagerOperation.md +33 -0
  24. package/enumerations/OverflowDirection.md +29 -0
  25. package/enumerations/RECORD_DATE_FORMAT.md +27 -0
  26. package/enumerations/SelectionMode.md +2 -2
  27. package/enumerations/StorageType.md +37 -0
  28. package/enumerations/UserInterface.md +15 -5
  29. package/globals.md +25 -0
  30. package/interfaces/DUActionInterceptor.md +1 -1
  31. package/interfaces/DataUnitInMemoryLoaderConfig.md +37 -0
  32. package/interfaces/IRepository.md +18 -0
  33. package/interfaces/LoadDataRequest.md +1 -1
  34. package/interfaces/OverFlowWatcherParams.md +67 -0
  35. package/interfaces/PageRequest.md +3 -3
  36. package/interfaces/PaginationInfo.md +25 -0
  37. package/interfaces/PaginationInfoBuilderParams.md +37 -0
  38. package/interfaces/QuickFilter.md +3 -3
  39. package/interfaces/Record.md +4 -4
  40. package/interfaces/SavedRecord.md +5 -5
  41. package/interfaces/WaitingChange.md +3 -3
  42. package/namespaces/MaskFormatter/type-aliases/MaskCharacter.md +1 -1
  43. package/namespaces/MaskFormatter/variables/MaskCharacter.md +1 -1
  44. package/package.json +1 -1
  45. package/type-aliases/DataUnitEventOptions.md +17 -0
  46. package/type-aliases/OnOverflowCallBack.md +25 -0
  47. package/variables/OVERFLOWED_CLASS_NAME.md +13 -0
@@ -30,7 +30,7 @@
30
30
 
31
31
  #### Source
32
32
 
33
- src/dataunit/DataUnit.ts:1915
33
+ src/dataunit/DataUnit.ts:2098
34
34
 
35
35
  ## Properties
36
36
 
@@ -40,7 +40,7 @@ src/dataunit/DataUnit.ts:1915
40
40
 
41
41
  #### Source
42
42
 
43
- src/dataunit/DataUnit.ts:1909
43
+ src/dataunit/DataUnit.ts:2095
44
44
 
45
45
  ***
46
46
 
@@ -50,7 +50,7 @@ src/dataunit/DataUnit.ts:1909
50
50
 
51
51
  #### Source
52
52
 
53
- src/dataunit/DataUnit.ts:1911
53
+ src/dataunit/DataUnit.ts:2096
54
54
 
55
55
  ***
56
56
 
@@ -60,7 +60,21 @@ src/dataunit/DataUnit.ts:1911
60
60
 
61
61
  #### Source
62
62
 
63
- src/dataunit/DataUnit.ts:1912
63
+ src/dataunit/DataUnit.ts:2092
64
+
65
+ ***
66
+
67
+ ### getAllRecords()?
68
+
69
+ > `optional` **getAllRecords**: () => `undefined` \| [`Record`](../interfaces/Record.md)[]
70
+
71
+ #### Returns
72
+
73
+ `undefined` \| [`Record`](../interfaces/Record.md)[]
74
+
75
+ #### Source
76
+
77
+ src/dataunit/DataUnit.ts:2094
64
78
 
65
79
  ***
66
80
 
@@ -70,7 +84,7 @@ src/dataunit/DataUnit.ts:1912
70
84
 
71
85
  #### Source
72
86
 
73
- src/dataunit/DataUnit.ts:1910
87
+ src/dataunit/DataUnit.ts:2091
74
88
 
75
89
  ***
76
90
 
@@ -80,7 +94,7 @@ src/dataunit/DataUnit.ts:1910
80
94
 
81
95
  #### Source
82
96
 
83
- src/dataunit/DataUnit.ts:1913
97
+ src/dataunit/DataUnit.ts:2093
84
98
 
85
99
  ## Accessors
86
100
 
@@ -94,7 +108,7 @@ src/dataunit/DataUnit.ts:1913
94
108
 
95
109
  #### Source
96
110
 
97
- src/dataunit/DataUnit.ts:1940
111
+ src/dataunit/DataUnit.ts:2126
98
112
 
99
113
  ***
100
114
 
@@ -108,7 +122,7 @@ src/dataunit/DataUnit.ts:1940
108
122
 
109
123
  #### Source
110
124
 
111
- src/dataunit/DataUnit.ts:1930
125
+ src/dataunit/DataUnit.ts:2116
112
126
 
113
127
  ***
114
128
 
@@ -122,7 +136,7 @@ src/dataunit/DataUnit.ts:1930
122
136
 
123
137
  #### Source
124
138
 
125
- src/dataunit/DataUnit.ts:1923
139
+ src/dataunit/DataUnit.ts:2106
126
140
 
127
141
  ## Methods
128
142
 
@@ -136,7 +150,7 @@ src/dataunit/DataUnit.ts:1923
136
150
 
137
151
  #### Source
138
152
 
139
- src/dataunit/DataUnit.ts:1947
153
+ src/dataunit/DataUnit.ts:2133
140
154
 
141
155
  ***
142
156
 
@@ -150,4 +164,4 @@ src/dataunit/DataUnit.ts:1947
150
164
 
151
165
  #### Source
152
166
 
153
- src/dataunit/DataUnit.ts:1951
167
+ src/dataunit/DataUnit.ts:2137
@@ -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
@@ -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
@@ -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
@@ -76,6 +76,30 @@ src/utils/StringUtils.ts:71
76
76
 
77
77
  ***
78
78
 
79
+ ### escapeString()
80
+
81
+ > `static` **escapeString**(`str`): `string`
82
+
83
+ Escapa caracteres especiais em uma string, usando sequencias de escape Unicode.
84
+
85
+ #### Parameters
86
+
87
+ • **str**: `string`
88
+
89
+ A string que deve sofrer alteração.
90
+
91
+ #### Returns
92
+
93
+ `string`
94
+
95
+ String com valores alterados.
96
+
97
+ #### Source
98
+
99
+ src/utils/StringUtils.ts:552
100
+
101
+ ***
102
+
79
103
  ### formatBytes()
80
104
 
81
105
  > `static` **formatBytes**(`bytes`): `string`
@@ -131,7 +155,7 @@ src/utils/StringUtils.ts:381
131
155
 
132
156
  #### Source
133
157
 
134
- src/utils/StringUtils.ts:485
158
+ src/utils/StringUtils.ts:489
135
159
 
136
160
  ***
137
161
 
@@ -190,7 +214,7 @@ A string invertida
190
214
 
191
215
  #### Source
192
216
 
193
- src/utils/StringUtils.ts:416
217
+ src/utils/StringUtils.ts:419
194
218
 
195
219
  ***
196
220
 
@@ -208,7 +232,7 @@ src/utils/StringUtils.ts:416
208
232
 
209
233
  #### Source
210
234
 
211
- src/utils/StringUtils.ts:457
235
+ src/utils/StringUtils.ts:461
212
236
 
213
237
  ***
214
238
 
@@ -264,7 +288,7 @@ src/utils/StringUtils.ts:158
264
288
 
265
289
  #### Source
266
290
 
267
- src/utils/StringUtils.ts:489
291
+ src/utils/StringUtils.ts:493
268
292
 
269
293
  ***
270
294
 
@@ -337,7 +361,7 @@ Se a string é minúscula
337
361
 
338
362
  #### Source
339
363
 
340
- src/utils/StringUtils.ts:404
364
+ src/utils/StringUtils.ts:406
341
365
 
342
366
  ***
343
367
 
@@ -486,7 +510,7 @@ src/utils/StringUtils.ts:360
486
510
 
487
511
  #### Source
488
512
 
489
- src/utils/StringUtils.ts:476
513
+ src/utils/StringUtils.ts:480
490
514
 
491
515
  ***
492
516
 
@@ -537,7 +561,7 @@ src/utils/StringUtils.ts:124
537
561
 
538
562
  #### Source
539
563
 
540
- src/utils/StringUtils.ts:437
564
+ src/utils/StringUtils.ts:441
541
565
 
542
566
  ***
543
567
 
@@ -639,7 +663,7 @@ src/utils/StringUtils.ts:49
639
663
 
640
664
  #### Source
641
665
 
642
- src/utils/StringUtils.ts:467
666
+ src/utils/StringUtils.ts:471
643
667
 
644
668
  ***
645
669
 
@@ -683,7 +707,7 @@ src/utils/StringUtils.ts:325
683
707
 
684
708
  #### Source
685
709
 
686
- src/utils/StringUtils.ts:420
710
+ src/utils/StringUtils.ts:424
687
711
 
688
712
  ***
689
713
 
@@ -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