@sankhyalabs/core-docs 0.0.0-hotfix-rc-KB-999998-5.0-rc.0 → 0.0.0-hotfix-ga-5726442.0

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.
@@ -26,7 +26,7 @@ Nome do atributo que será utilizado para controlar contexto de locks nos elemen
26
26
 
27
27
  #### Source
28
28
 
29
- src/utils/LockManager.ts:24
29
+ src/utils/LockManager.ts:28
30
30
 
31
31
  ***
32
32
 
@@ -36,7 +36,7 @@ src/utils/LockManager.ts:24
36
36
 
37
37
  #### Source
38
38
 
39
- src/utils/LockManager.ts:19
39
+ src/utils/LockManager.ts:23
40
40
 
41
41
  ## Methods
42
42
 
@@ -60,7 +60,7 @@ Elemento de de onde o lock deve começar.
60
60
 
61
61
  #### Source
62
62
 
63
- src/utils/LockManager.ts:83
63
+ src/utils/LockManager.ts:87
64
64
 
65
65
  ***
66
66
 
@@ -74,7 +74,7 @@ src/utils/LockManager.ts:83
74
74
 
75
75
  #### Source
76
76
 
77
- src/utils/LockManager.ts:26
77
+ src/utils/LockManager.ts:30
78
78
 
79
79
  ***
80
80
 
@@ -86,7 +86,7 @@ src/utils/LockManager.ts:26
86
86
 
87
87
  • **ctxId**: `string` \| `HTMLElement`
88
88
 
89
- • **operation**: [`TASKBAR_CLICK`](../enumerations/LockManagerOperation.md#taskbar_click)
89
+ • **operation**: [`LockManagerOperation`](../enumerations/LockManagerOperation.md)
90
90
 
91
91
  #### Returns
92
92
 
@@ -94,7 +94,7 @@ src/utils/LockManager.ts:26
94
94
 
95
95
  #### Source
96
96
 
97
- src/utils/LockManager.ts:30
97
+ src/utils/LockManager.ts:34
98
98
 
99
99
  ***
100
100
 
@@ -112,13 +112,13 @@ src/utils/LockManager.ts:30
112
112
 
113
113
  #### Source
114
114
 
115
- src/utils/LockManager.ts:43
115
+ src/utils/LockManager.ts:47
116
116
 
117
117
  ***
118
118
 
119
119
  ### lock()
120
120
 
121
- > `static` **lock**(`id`, `operation`): `any`
121
+ > `static` **lock**(`id`, `operation`): () => `void`
122
122
 
123
123
  Inicia um locker baseado em um contexto e uma operação.
124
124
 
@@ -128,19 +128,51 @@ Inicia um locker baseado em um contexto e uma operação.
128
128
 
129
129
  Pode ser um ID do contexto de locker, ou, o elemento contendo um contexto de locker.
130
130
 
131
- • **operation**: [`TASKBAR_CLICK`](../enumerations/LockManagerOperation.md#taskbar_click)
131
+ • **operation**: [`LockManagerOperation`](../enumerations/LockManagerOperation.md)
132
132
 
133
133
  Operação do contexto que o lock deve ser feito.
134
134
 
135
135
  #### Returns
136
136
 
137
- `any`
137
+ `Function`
138
138
 
139
139
  - Uma função que fara a liberação do lock.
140
140
 
141
+ ##### Returns
142
+
143
+ `void`
144
+
145
+ #### Source
146
+
147
+ src/utils/LockManager.ts:137
148
+
149
+ ***
150
+
151
+ ### resetLocks()
152
+
153
+ > `static` **resetLocks**(`id`, `operation`): `Promise`\<`void`\>
154
+
155
+ Reseta todos os locks existentes para um determinado contexto e operação de forma assíncrona
156
+
157
+ #### Parameters
158
+
159
+ • **id**: `string` \| `HTMLElement`
160
+
161
+ ID do contexto ou elemento HTML contendo contexto
162
+
163
+ • **operation**: [`LockManagerOperation`](../enumerations/LockManagerOperation.md)
164
+
165
+ Operação específica para resetar os locks
166
+
167
+ #### Returns
168
+
169
+ `Promise`\<`void`\>
170
+
171
+ Promise que será resolvida quando todos os locks forem resetados
172
+
141
173
  #### Source
142
174
 
143
- src/utils/LockManager.ts:114
175
+ src/utils/LockManager.ts:111
144
176
 
145
177
  ***
146
178
 
@@ -160,13 +192,35 @@ src/utils/LockManager.ts:114
160
192
 
161
193
  #### Source
162
194
 
163
- src/utils/LockManager.ts:65
195
+ src/utils/LockManager.ts:69
196
+
197
+ ***
198
+
199
+ ### whenHasLock()
200
+
201
+ > `static` **whenHasLock**(`id`, `operation`, `timeOut`?): `Promise`\<`void`\>
202
+
203
+ #### Parameters
204
+
205
+ • **id**: `string` \| `HTMLElement`
206
+
207
+ • **operation**: [`LockManagerOperation`](../enumerations/LockManagerOperation.md)
208
+
209
+ • **timeOut?**: `number`
210
+
211
+ #### Returns
212
+
213
+ `Promise`\<`void`\>
214
+
215
+ #### Source
216
+
217
+ src/utils/LockManager.ts:191
164
218
 
165
219
  ***
166
220
 
167
221
  ### whenResolve()
168
222
 
169
- > `static` **whenResolve**(`id`, `operation`): `Promise`\<`void`\>
223
+ > `static` **whenResolve**(`id`, `operation`, `debounce`?, `timeOut`?): `Promise`\<`void`\>
170
224
 
171
225
  Aguarda todos os lockers de um contexto e operação serem resolvidos.
172
226
 
@@ -176,10 +230,14 @@ Aguarda todos os lockers de um contexto e operação serem resolvidos.
176
230
 
177
231
  Pode ser um ID do contexto de locker, ou, o elemento contendo um contexto de locker.
178
232
 
179
- • **operation**: [`TASKBAR_CLICK`](../enumerations/LockManagerOperation.md#taskbar_click)
233
+ • **operation**: [`LockManagerOperation`](../enumerations/LockManagerOperation.md)
180
234
 
181
235
  Operação do contexto que devera aguardar.
182
236
 
237
+ • **debounce?**: `number`
238
+
239
+ • **timeOut?**: `number`
240
+
183
241
  #### Returns
184
242
 
185
243
  `Promise`\<`void`\>
@@ -188,4 +246,4 @@ Operação do contexto que devera aguardar.
188
246
 
189
247
  #### Source
190
248
 
191
- src/utils/LockManager.ts:142
249
+ src/utils/LockManager.ts:164
@@ -170,7 +170,7 @@ src/utils/OverflowWatcher/index.ts:52
170
170
 
171
171
  #### Source
172
172
 
173
- src/utils/OverflowWatcher/index.ts:205
173
+ src/utils/OverflowWatcher/index.ts:206
174
174
 
175
175
  ***
176
176
 
@@ -188,7 +188,7 @@ src/utils/OverflowWatcher/index.ts:205
188
188
 
189
189
  #### Source
190
190
 
191
- src/utils/OverflowWatcher/index.ts:212
191
+ src/utils/OverflowWatcher/index.ts:213
192
192
 
193
193
  ***
194
194
 
@@ -206,7 +206,7 @@ src/utils/OverflowWatcher/index.ts:212
206
206
 
207
207
  #### Source
208
208
 
209
- src/utils/OverflowWatcher/index.ts:177
209
+ src/utils/OverflowWatcher/index.ts:178
210
210
 
211
211
  ***
212
212
 
@@ -224,7 +224,7 @@ src/utils/OverflowWatcher/index.ts:177
224
224
 
225
225
  #### Source
226
226
 
227
- src/utils/OverflowWatcher/index.ts:187
227
+ src/utils/OverflowWatcher/index.ts:188
228
228
 
229
229
  ***
230
230
 
@@ -260,7 +260,7 @@ src/utils/OverflowWatcher/index.ts:96
260
260
 
261
261
  #### Source
262
262
 
263
- src/utils/OverflowWatcher/index.ts:157
263
+ src/utils/OverflowWatcher/index.ts:158
264
264
 
265
265
  ***
266
266
 
@@ -310,7 +310,7 @@ src/utils/OverflowWatcher/index.ts:58
310
310
 
311
311
  #### Source
312
312
 
313
- src/utils/OverflowWatcher/index.ts:166
313
+ src/utils/OverflowWatcher/index.ts:167
314
314
 
315
315
  ***
316
316
 
@@ -342,7 +342,7 @@ src/utils/OverflowWatcher/index.ts:62
342
342
 
343
343
  #### Source
344
344
 
345
- src/utils/OverflowWatcher/index.ts:162
345
+ src/utils/OverflowWatcher/index.ts:163
346
346
 
347
347
  ***
348
348
 
@@ -360,7 +360,7 @@ src/utils/OverflowWatcher/index.ts:162
360
360
 
361
361
  #### Source
362
362
 
363
- src/utils/OverflowWatcher/index.ts:197
363
+ src/utils/OverflowWatcher/index.ts:198
364
364
 
365
365
  ***
366
366
 
@@ -416,7 +416,7 @@ src/utils/OverflowWatcher/index.ts:100
416
416
 
417
417
  #### Source
418
418
 
419
- src/utils/OverflowWatcher/index.ts:153
419
+ src/utils/OverflowWatcher/index.ts:154
420
420
 
421
421
  ***
422
422
 
@@ -434,7 +434,7 @@ src/utils/OverflowWatcher/index.ts:153
434
434
 
435
435
  #### Source
436
436
 
437
- src/utils/OverflowWatcher/index.ts:226
437
+ src/utils/OverflowWatcher/index.ts:227
438
438
 
439
439
  ***
440
440
 
@@ -492,7 +492,7 @@ src/utils/OverflowWatcher/index.ts:131
492
492
 
493
493
  #### Source
494
494
 
495
- src/utils/OverflowWatcher/index.ts:192
495
+ src/utils/OverflowWatcher/index.ts:193
496
496
 
497
497
  ***
498
498
 
@@ -30,7 +30,7 @@
30
30
 
31
31
  #### Source
32
32
 
33
- src/dataunit/DataUnit.ts:2071
33
+ src/dataunit/DataUnit.ts:2088
34
34
 
35
35
  ## Properties
36
36
 
@@ -40,7 +40,7 @@ src/dataunit/DataUnit.ts:2071
40
40
 
41
41
  #### Source
42
42
 
43
- src/dataunit/DataUnit.ts:2068
43
+ src/dataunit/DataUnit.ts:2085
44
44
 
45
45
  ***
46
46
 
@@ -50,7 +50,7 @@ src/dataunit/DataUnit.ts:2068
50
50
 
51
51
  #### Source
52
52
 
53
- src/dataunit/DataUnit.ts:2069
53
+ src/dataunit/DataUnit.ts:2086
54
54
 
55
55
  ***
56
56
 
@@ -60,7 +60,7 @@ src/dataunit/DataUnit.ts:2069
60
60
 
61
61
  #### Source
62
62
 
63
- src/dataunit/DataUnit.ts:2065
63
+ src/dataunit/DataUnit.ts:2082
64
64
 
65
65
  ***
66
66
 
@@ -74,7 +74,7 @@ src/dataunit/DataUnit.ts:2065
74
74
 
75
75
  #### Source
76
76
 
77
- src/dataunit/DataUnit.ts:2067
77
+ src/dataunit/DataUnit.ts:2084
78
78
 
79
79
  ***
80
80
 
@@ -84,7 +84,7 @@ src/dataunit/DataUnit.ts:2067
84
84
 
85
85
  #### Source
86
86
 
87
- src/dataunit/DataUnit.ts:2064
87
+ src/dataunit/DataUnit.ts:2081
88
88
 
89
89
  ***
90
90
 
@@ -94,7 +94,7 @@ src/dataunit/DataUnit.ts:2064
94
94
 
95
95
  #### Source
96
96
 
97
- src/dataunit/DataUnit.ts:2066
97
+ src/dataunit/DataUnit.ts:2083
98
98
 
99
99
  ## Accessors
100
100
 
@@ -108,7 +108,7 @@ src/dataunit/DataUnit.ts:2066
108
108
 
109
109
  #### Source
110
110
 
111
- src/dataunit/DataUnit.ts:2099
111
+ src/dataunit/DataUnit.ts:2116
112
112
 
113
113
  ***
114
114
 
@@ -122,7 +122,7 @@ src/dataunit/DataUnit.ts:2099
122
122
 
123
123
  #### Source
124
124
 
125
- src/dataunit/DataUnit.ts:2089
125
+ src/dataunit/DataUnit.ts:2106
126
126
 
127
127
  ***
128
128
 
@@ -136,7 +136,7 @@ src/dataunit/DataUnit.ts:2089
136
136
 
137
137
  #### Source
138
138
 
139
- src/dataunit/DataUnit.ts:2079
139
+ src/dataunit/DataUnit.ts:2096
140
140
 
141
141
  ## Methods
142
142
 
@@ -150,7 +150,7 @@ src/dataunit/DataUnit.ts:2079
150
150
 
151
151
  #### Source
152
152
 
153
- src/dataunit/DataUnit.ts:2106
153
+ src/dataunit/DataUnit.ts:2123
154
154
 
155
155
  ***
156
156
 
@@ -164,4 +164,4 @@ src/dataunit/DataUnit.ts:2106
164
164
 
165
165
  #### Source
166
166
 
167
- src/dataunit/DataUnit.ts:2110
167
+ src/dataunit/DataUnit.ts:2127
@@ -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
 
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1950
17
+ src/dataunit/DataUnit.ts:1967
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1950
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1952
27
+ src/dataunit/DataUnit.ts:1969
28
28
 
29
29
  ***
30
30
 
@@ -34,7 +34,7 @@ src/dataunit/DataUnit.ts:1952
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1949
37
+ src/dataunit/DataUnit.ts:1966
38
38
 
39
39
  ***
40
40
 
@@ -44,4 +44,4 @@ src/dataunit/DataUnit.ts:1949
44
44
 
45
45
  #### Source
46
46
 
47
- src/dataunit/DataUnit.ts:1951
47
+ src/dataunit/DataUnit.ts:1968
@@ -10,6 +10,18 @@ Define os tipos de operação que o locker pode controlar
10
10
 
11
11
  ## Enumeration Members
12
12
 
13
+ ### APP\_LOADING
14
+
15
+ > **APP\_LOADING**: `"app_loading"`
16
+
17
+ Operação de lock utilizada para controlar carregamento da aplicação.
18
+
19
+ #### Source
20
+
21
+ src/utils/LockManager.ts:13
22
+
23
+ ***
24
+
13
25
  ### TASKBAR\_CLICK
14
26
 
15
27
  > **TASKBAR\_CLICK**: `"taskbar_click"`
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:2058
17
+ src/dataunit/DataUnit.ts:2075
18
18
 
19
19
  ***
20
20
 
@@ -24,4 +24,4 @@ src/dataunit/DataUnit.ts:2058
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:2059
27
+ src/dataunit/DataUnit.ts:2076
@@ -22,4 +22,4 @@
22
22
 
23
23
  #### Source
24
24
 
25
- src/dataunit/DataUnit.ts:1933
25
+ src/dataunit/DataUnit.ts:1950
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/utils/OverflowWatcher/index.ts:233
17
+ src/utils/OverflowWatcher/index.ts:234
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/utils/OverflowWatcher/index.ts:233
24
24
 
25
25
  #### Source
26
26
 
27
- src/utils/OverflowWatcher/index.ts:236
27
+ src/utils/OverflowWatcher/index.ts:237
28
28
 
29
29
  ***
30
30
 
@@ -34,7 +34,7 @@ src/utils/OverflowWatcher/index.ts:236
34
34
 
35
35
  #### Source
36
36
 
37
- src/utils/OverflowWatcher/index.ts:235
37
+ src/utils/OverflowWatcher/index.ts:236
38
38
 
39
39
  ***
40
40
 
@@ -44,7 +44,7 @@ src/utils/OverflowWatcher/index.ts:235
44
44
 
45
45
  #### Source
46
46
 
47
- src/utils/OverflowWatcher/index.ts:232
47
+ src/utils/OverflowWatcher/index.ts:233
48
48
 
49
49
  ***
50
50
 
@@ -54,7 +54,7 @@ src/utils/OverflowWatcher/index.ts:232
54
54
 
55
55
  #### Source
56
56
 
57
- src/utils/OverflowWatcher/index.ts:237
57
+ src/utils/OverflowWatcher/index.ts:238
58
58
 
59
59
  ***
60
60
 
@@ -64,4 +64,4 @@ src/utils/OverflowWatcher/index.ts:237
64
64
 
65
65
  #### Source
66
66
 
67
- src/utils/OverflowWatcher/index.ts:234
67
+ src/utils/OverflowWatcher/index.ts:235
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:2038
17
+ src/dataunit/DataUnit.ts:2055
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:2038
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:2039
27
+ src/dataunit/DataUnit.ts:2056
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:2039
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:2040
37
+ src/dataunit/DataUnit.ts:2057
@@ -10,6 +10,18 @@ Informações da paginação retornada na requisição de carregamento de regist
10
10
 
11
11
  ## Properties
12
12
 
13
+ ### askRowsLimit?
14
+
15
+ > `optional` **askRowsLimit**: `number`
16
+
17
+ Informa se deve exibir diálogo para cancelar carregamento de registros
18
+
19
+ #### Source
20
+
21
+ src/dataunit/loading/PaginationInfo.ts:30
22
+
23
+ ***
24
+
13
25
  ### count?
14
26
 
15
27
  > `optional` **count**: `number`
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:2045
17
+ src/dataunit/DataUnit.ts:2062
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:2045
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:2046
27
+ src/dataunit/DataUnit.ts:2063
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:2046
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:2044
37
+ src/dataunit/DataUnit.ts:2061
@@ -22,7 +22,7 @@
22
22
 
23
23
  #### Source
24
24
 
25
- src/dataunit/DataUnit.ts:1940
25
+ src/dataunit/DataUnit.ts:1957
26
26
 
27
27
  ***
28
28
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1940
32
32
 
33
33
  #### Source
34
34
 
35
- src/dataunit/DataUnit.ts:1939
35
+ src/dataunit/DataUnit.ts:1956
36
36
 
37
37
  ***
38
38
 
@@ -42,7 +42,7 @@ src/dataunit/DataUnit.ts:1939
42
42
 
43
43
  #### Source
44
44
 
45
- src/dataunit/DataUnit.ts:1937
45
+ src/dataunit/DataUnit.ts:1954
46
46
 
47
47
  ***
48
48
 
@@ -52,4 +52,4 @@ src/dataunit/DataUnit.ts:1937
52
52
 
53
53
  #### Source
54
54
 
55
- src/dataunit/DataUnit.ts:1938
55
+ src/dataunit/DataUnit.ts:1955
@@ -18,7 +18,7 @@
18
18
 
19
19
  #### Source
20
20
 
21
- src/dataunit/DataUnit.ts:1945
21
+ src/dataunit/DataUnit.ts:1962
22
22
 
23
23
  ***
24
24
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1945
32
32
 
33
33
  #### Source
34
34
 
35
- src/dataunit/DataUnit.ts:1940
35
+ src/dataunit/DataUnit.ts:1957
36
36
 
37
37
  ***
38
38
 
@@ -46,7 +46,7 @@ src/dataunit/DataUnit.ts:1940
46
46
 
47
47
  #### Source
48
48
 
49
- src/dataunit/DataUnit.ts:1939
49
+ src/dataunit/DataUnit.ts:1956
50
50
 
51
51
  ***
52
52
 
@@ -60,7 +60,7 @@ src/dataunit/DataUnit.ts:1939
60
60
 
61
61
  #### Source
62
62
 
63
- src/dataunit/DataUnit.ts:1937
63
+ src/dataunit/DataUnit.ts:1954
64
64
 
65
65
  ***
66
66
 
@@ -74,4 +74,4 @@ src/dataunit/DataUnit.ts:1937
74
74
 
75
75
  #### Source
76
76
 
77
- src/dataunit/DataUnit.ts:1938
77
+ src/dataunit/DataUnit.ts:1955
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:2033
17
+ src/dataunit/DataUnit.ts:2050
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:2033
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:2034
27
+ src/dataunit/DataUnit.ts:2051
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:2034
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:2032
37
+ src/dataunit/DataUnit.ts:2049
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/core-docs",
3
- "version": "0.0.0-hotfix-rc-KB-999998-5.0-rc.0",
3
+ "version": "0.0.0-hotfix-ga-5726442.0",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [
@@ -14,4 +14,4 @@
14
14
 
15
15
  ## Source
16
16
 
17
- src/dataunit/DataUnit.ts:2115
17
+ src/dataunit/DataUnit.ts:2132