@sankhyalabs/core-docs 0.0.0-feat-dev-KB-51327.0 → 0.0.0-feat-dev-KB-74304-3.1
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.
package/classes/LockManager.md
CHANGED
@@ -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:
|
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:
|
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:
|
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:
|
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**: [`
|
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:
|
97
|
+
src/utils/LockManager.ts:34
|
98
98
|
|
99
99
|
***
|
100
100
|
|
@@ -112,13 +112,27 @@ src/utils/LockManager.ts:30
|
|
112
112
|
|
113
113
|
#### Source
|
114
114
|
|
115
|
-
src/utils/LockManager.ts:
|
115
|
+
src/utils/LockManager.ts:47
|
116
|
+
|
117
|
+
***
|
118
|
+
|
119
|
+
### getTime()
|
120
|
+
|
121
|
+
> `static` `private` **getTime**(): `string`
|
122
|
+
|
123
|
+
#### Returns
|
124
|
+
|
125
|
+
`string`
|
126
|
+
|
127
|
+
#### Source
|
128
|
+
|
129
|
+
src/utils/LockManager.ts:235
|
116
130
|
|
117
131
|
***
|
118
132
|
|
119
133
|
### lock()
|
120
134
|
|
121
|
-
> `static` **lock**(`id`, `operation`): `
|
135
|
+
> `static` **lock**(`id`, `operation`): () => `void`
|
122
136
|
|
123
137
|
Inicia um locker baseado em um contexto e uma operação.
|
124
138
|
|
@@ -128,19 +142,51 @@ Inicia um locker baseado em um contexto e uma operação.
|
|
128
142
|
|
129
143
|
Pode ser um ID do contexto de locker, ou, o elemento contendo um contexto de locker.
|
130
144
|
|
131
|
-
• **operation**: [`
|
145
|
+
• **operation**: [`LockManagerOperation`](../enumerations/LockManagerOperation.md)
|
132
146
|
|
133
147
|
Operação do contexto que o lock deve ser feito.
|
134
148
|
|
135
149
|
#### Returns
|
136
150
|
|
137
|
-
`
|
151
|
+
`Function`
|
138
152
|
|
139
153
|
- Uma função que fara a liberação do lock.
|
140
154
|
|
155
|
+
##### Returns
|
156
|
+
|
157
|
+
`void`
|
158
|
+
|
141
159
|
#### Source
|
142
160
|
|
143
|
-
src/utils/LockManager.ts:
|
161
|
+
src/utils/LockManager.ts:146
|
162
|
+
|
163
|
+
***
|
164
|
+
|
165
|
+
### resetLocks()
|
166
|
+
|
167
|
+
> `static` **resetLocks**(`id`, `operation`): `Promise`\<`void`\>
|
168
|
+
|
169
|
+
Reseta todos os locks existentes para um determinado contexto e operação de forma assíncrona
|
170
|
+
|
171
|
+
#### Parameters
|
172
|
+
|
173
|
+
• **id**: `string` \| `HTMLElement`
|
174
|
+
|
175
|
+
ID do contexto ou elemento HTML contendo contexto
|
176
|
+
|
177
|
+
• **operation**: [`LockManagerOperation`](../enumerations/LockManagerOperation.md)
|
178
|
+
|
179
|
+
Operação específica para resetar os locks
|
180
|
+
|
181
|
+
#### Returns
|
182
|
+
|
183
|
+
`Promise`\<`void`\>
|
184
|
+
|
185
|
+
Promise que será resolvida quando todos os locks forem resetados
|
186
|
+
|
187
|
+
#### Source
|
188
|
+
|
189
|
+
src/utils/LockManager.ts:116
|
144
190
|
|
145
191
|
***
|
146
192
|
|
@@ -160,13 +206,35 @@ src/utils/LockManager.ts:114
|
|
160
206
|
|
161
207
|
#### Source
|
162
208
|
|
163
|
-
src/utils/LockManager.ts:
|
209
|
+
src/utils/LockManager.ts:69
|
210
|
+
|
211
|
+
***
|
212
|
+
|
213
|
+
### whenHasLock()
|
214
|
+
|
215
|
+
> `static` **whenHasLock**(`id`, `operation`, `timeOut`?): `Promise`\<`void`\>
|
216
|
+
|
217
|
+
#### Parameters
|
218
|
+
|
219
|
+
• **id**: `string` \| `HTMLElement`
|
220
|
+
|
221
|
+
• **operation**: [`LockManagerOperation`](../enumerations/LockManagerOperation.md)
|
222
|
+
|
223
|
+
• **timeOut?**: `number`
|
224
|
+
|
225
|
+
#### Returns
|
226
|
+
|
227
|
+
`Promise`\<`void`\>
|
228
|
+
|
229
|
+
#### Source
|
230
|
+
|
231
|
+
src/utils/LockManager.ts:213
|
164
232
|
|
165
233
|
***
|
166
234
|
|
167
235
|
### whenResolve()
|
168
236
|
|
169
|
-
> `static` **whenResolve**(`id`, `operation`): `Promise`\<`void`\>
|
237
|
+
> `static` **whenResolve**(`id`, `operation`, `debounce`?, `timeOut`?): `Promise`\<`void`\>
|
170
238
|
|
171
239
|
Aguarda todos os lockers de um contexto e operação serem resolvidos.
|
172
240
|
|
@@ -176,10 +244,14 @@ Aguarda todos os lockers de um contexto e operação serem resolvidos.
|
|
176
244
|
|
177
245
|
Pode ser um ID do contexto de locker, ou, o elemento contendo um contexto de locker.
|
178
246
|
|
179
|
-
• **operation**: [`
|
247
|
+
• **operation**: [`LockManagerOperation`](../enumerations/LockManagerOperation.md)
|
180
248
|
|
181
249
|
Operação do contexto que devera aguardar.
|
182
250
|
|
251
|
+
• **debounce?**: `number`
|
252
|
+
|
253
|
+
• **timeOut?**: `number`
|
254
|
+
|
183
255
|
#### Returns
|
184
256
|
|
185
257
|
`Promise`\<`void`\>
|
@@ -188,4 +260,4 @@ Operação do contexto que devera aguardar.
|
|
188
260
|
|
189
261
|
#### Source
|
190
262
|
|
191
|
-
src/utils/LockManager.ts:
|
263
|
+
src/utils/LockManager.ts:179
|
@@ -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"`
|