@sankhyalabs/core-docs 5.20.0-dev.62 → 5.20.0-dev.63

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 (4) hide show
  1. package/classes/LockManager.md +73 -15
  2. package/classes/UserAgentUtils.md +15 -1
  3. package/enumerations/LockManagerOperation.md +12 -0
  4. package/package.json +1 -1
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: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:142
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:116
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:196
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:169
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/LockManagerOperation.md CHANGED
@@ -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"`
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/core-docs",
3
- "version": "5.20.0-dev.62",
3
+ "version": "5.20.0-dev.63",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [