@sankhyalabs/core-docs 0.0.0-feat-dev-KB-74304-3.2 → 0.0.0-feat-dev-KB-79444.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.
Files changed (16) hide show
  1. package/classes/Change.md +11 -11
  2. package/classes/DataUnit.md +93 -93
  3. package/classes/LockManager.md +15 -87
  4. package/classes/SelectionInfo.md +12 -12
  5. package/classes/UserAgentUtils.md +1 -15
  6. package/enumerations/ChangeOperation.md +4 -4
  7. package/enumerations/LockManagerOperation.md +0 -12
  8. package/enumerations/SelectionMode.md +2 -2
  9. package/interfaces/DUActionInterceptor.md +1 -1
  10. package/interfaces/PageRequest.md +3 -3
  11. package/interfaces/QuickFilter.md +3 -3
  12. package/interfaces/Record.md +4 -4
  13. package/interfaces/SavedRecord.md +5 -5
  14. package/interfaces/WaitingChange.md +3 -3
  15. package/package.json +1 -1
  16. package/type-aliases/DataUnitEventOptions.md +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:28
29
+ src/utils/LockManager.ts:24
30
30
 
31
31
  ***
32
32
 
@@ -36,7 +36,7 @@ src/utils/LockManager.ts:28
36
36
 
37
37
  #### Source
38
38
 
39
- src/utils/LockManager.ts:23
39
+ src/utils/LockManager.ts:19
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:87
63
+ src/utils/LockManager.ts:83
64
64
 
65
65
  ***
66
66
 
@@ -74,7 +74,7 @@ src/utils/LockManager.ts:87
74
74
 
75
75
  #### Source
76
76
 
77
- src/utils/LockManager.ts:30
77
+ src/utils/LockManager.ts:26
78
78
 
79
79
  ***
80
80
 
@@ -86,7 +86,7 @@ src/utils/LockManager.ts:30
86
86
 
87
87
  • **ctxId**: `string` \| `HTMLElement`
88
88
 
89
- • **operation**: [`LockManagerOperation`](../enumerations/LockManagerOperation.md)
89
+ • **operation**: [`TASKBAR_CLICK`](../enumerations/LockManagerOperation.md#taskbar_click)
90
90
 
91
91
  #### Returns
92
92
 
@@ -94,7 +94,7 @@ src/utils/LockManager.ts:30
94
94
 
95
95
  #### Source
96
96
 
97
- src/utils/LockManager.ts:34
97
+ src/utils/LockManager.ts:30
98
98
 
99
99
  ***
100
100
 
@@ -112,27 +112,13 @@ src/utils/LockManager.ts:34
112
112
 
113
113
  #### Source
114
114
 
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
115
+ src/utils/LockManager.ts:43
130
116
 
131
117
  ***
132
118
 
133
119
  ### lock()
134
120
 
135
- > `static` **lock**(`id`, `operation`): () => `void`
121
+ > `static` **lock**(`id`, `operation`): `any`
136
122
 
137
123
  Inicia um locker baseado em um contexto e uma operação.
138
124
 
@@ -142,51 +128,19 @@ Inicia um locker baseado em um contexto e uma operação.
142
128
 
143
129
  Pode ser um ID do contexto de locker, ou, o elemento contendo um contexto de locker.
144
130
 
145
- • **operation**: [`LockManagerOperation`](../enumerations/LockManagerOperation.md)
131
+ • **operation**: [`TASKBAR_CLICK`](../enumerations/LockManagerOperation.md#taskbar_click)
146
132
 
147
133
  Operação do contexto que o lock deve ser feito.
148
134
 
149
135
  #### Returns
150
136
 
151
- `Function`
137
+ `any`
152
138
 
153
139
  - Uma função que fara a liberação do lock.
154
140
 
155
- ##### Returns
156
-
157
- `void`
158
-
159
141
  #### Source
160
142
 
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
143
+ src/utils/LockManager.ts:114
190
144
 
191
145
  ***
192
146
 
@@ -206,35 +160,13 @@ src/utils/LockManager.ts:116
206
160
 
207
161
  #### Source
208
162
 
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
163
+ src/utils/LockManager.ts:65
232
164
 
233
165
  ***
234
166
 
235
167
  ### whenResolve()
236
168
 
237
- > `static` **whenResolve**(`id`, `operation`, `debounce`?, `timeOut`?): `Promise`\<`void`\>
169
+ > `static` **whenResolve**(`id`, `operation`): `Promise`\<`void`\>
238
170
 
239
171
  Aguarda todos os lockers de um contexto e operação serem resolvidos.
240
172
 
@@ -244,14 +176,10 @@ Aguarda todos os lockers de um contexto e operação serem resolvidos.
244
176
 
245
177
  Pode ser um ID do contexto de locker, ou, o elemento contendo um contexto de locker.
246
178
 
247
- • **operation**: [`LockManagerOperation`](../enumerations/LockManagerOperation.md)
179
+ • **operation**: [`TASKBAR_CLICK`](../enumerations/LockManagerOperation.md#taskbar_click)
248
180
 
249
181
  Operação do contexto que devera aguardar.
250
182
 
251
- • **debounce?**: `number`
252
-
253
- • **timeOut?**: `number`
254
-
255
183
  #### Returns
256
184
 
257
185
  `Promise`\<`void`\>
@@ -260,4 +188,4 @@ Operação do contexto que devera aguardar.
260
188
 
261
189
  #### Source
262
190
 
263
- src/utils/LockManager.ts:179
191
+ src/utils/LockManager.ts:142
package/classes/SelectionInfo.md CHANGED
@@ -30,7 +30,7 @@
30
30
 
31
31
  #### Source
32
32
 
33
- src/dataunit/DataUnit.ts:2032
33
+ src/dataunit/DataUnit.ts:2035
34
34
 
35
35
  ## Properties
36
36
 
@@ -40,7 +40,7 @@ src/dataunit/DataUnit.ts:2032
40
40
 
41
41
  #### Source
42
42
 
43
- src/dataunit/DataUnit.ts:2029
43
+ src/dataunit/DataUnit.ts:2032
44
44
 
45
45
  ***
46
46
 
@@ -50,7 +50,7 @@ src/dataunit/DataUnit.ts:2029
50
50
 
51
51
  #### Source
52
52
 
53
- src/dataunit/DataUnit.ts:2030
53
+ src/dataunit/DataUnit.ts:2033
54
54
 
55
55
  ***
56
56
 
@@ -60,7 +60,7 @@ src/dataunit/DataUnit.ts:2030
60
60
 
61
61
  #### Source
62
62
 
63
- src/dataunit/DataUnit.ts:2026
63
+ src/dataunit/DataUnit.ts:2029
64
64
 
65
65
  ***
66
66
 
@@ -74,7 +74,7 @@ src/dataunit/DataUnit.ts:2026
74
74
 
75
75
  #### Source
76
76
 
77
- src/dataunit/DataUnit.ts:2028
77
+ src/dataunit/DataUnit.ts:2031
78
78
 
79
79
  ***
80
80
 
@@ -84,7 +84,7 @@ src/dataunit/DataUnit.ts:2028
84
84
 
85
85
  #### Source
86
86
 
87
- src/dataunit/DataUnit.ts:2025
87
+ src/dataunit/DataUnit.ts:2028
88
88
 
89
89
  ***
90
90
 
@@ -94,7 +94,7 @@ src/dataunit/DataUnit.ts:2025
94
94
 
95
95
  #### Source
96
96
 
97
- src/dataunit/DataUnit.ts:2027
97
+ src/dataunit/DataUnit.ts:2030
98
98
 
99
99
  ## Accessors
100
100
 
@@ -108,7 +108,7 @@ src/dataunit/DataUnit.ts:2027
108
108
 
109
109
  #### Source
110
110
 
111
- src/dataunit/DataUnit.ts:2060
111
+ src/dataunit/DataUnit.ts:2063
112
112
 
113
113
  ***
114
114
 
@@ -122,7 +122,7 @@ src/dataunit/DataUnit.ts:2060
122
122
 
123
123
  #### Source
124
124
 
125
- src/dataunit/DataUnit.ts:2050
125
+ src/dataunit/DataUnit.ts:2053
126
126
 
127
127
  ***
128
128
 
@@ -136,7 +136,7 @@ src/dataunit/DataUnit.ts:2050
136
136
 
137
137
  #### Source
138
138
 
139
- src/dataunit/DataUnit.ts:2040
139
+ src/dataunit/DataUnit.ts:2043
140
140
 
141
141
  ## Methods
142
142
 
@@ -150,7 +150,7 @@ src/dataunit/DataUnit.ts:2040
150
150
 
151
151
  #### Source
152
152
 
153
- src/dataunit/DataUnit.ts:2067
153
+ src/dataunit/DataUnit.ts:2070
154
154
 
155
155
  ***
156
156
 
@@ -164,4 +164,4 @@ src/dataunit/DataUnit.ts:2067
164
164
 
165
165
  #### Source
166
166
 
167
- src/dataunit/DataUnit.ts:2071
167
+ src/dataunit/DataUnit.ts:2074
package/classes/UserAgentUtils.md CHANGED
@@ -34,21 +34,7 @@ Objeto com o nome e versão do navegador.
34
34
 
35
35
  #### Source
36
36
 
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
37
+ src/utils/UserAgentUtils/index.ts:22
52
38
 
53
39
  ***
54
40
 
package/enumerations/ChangeOperation.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1911
17
+ src/dataunit/DataUnit.ts:1914
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1911
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1913
27
+ src/dataunit/DataUnit.ts:1916
28
28
 
29
29
  ***
30
30
 
@@ -34,7 +34,7 @@ src/dataunit/DataUnit.ts:1913
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1910
37
+ src/dataunit/DataUnit.ts:1913
38
38
 
39
39
  ***
40
40
 
@@ -44,4 +44,4 @@ src/dataunit/DataUnit.ts:1910
44
44
 
45
45
  #### Source
46
46
 
47
- src/dataunit/DataUnit.ts:1912
47
+ src/dataunit/DataUnit.ts:1915
package/enumerations/LockManagerOperation.md CHANGED
@@ -10,18 +10,6 @@ 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
-
25
13
  ### TASKBAR\_CLICK
26
14
 
27
15
  > **TASKBAR\_CLICK**: `"taskbar_click"`
package/enumerations/SelectionMode.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:2019
17
+ src/dataunit/DataUnit.ts:2022
18
18
 
19
19
  ***
20
20
 
@@ -24,4 +24,4 @@ src/dataunit/DataUnit.ts:2019
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:2020
27
+ src/dataunit/DataUnit.ts:2023
package/interfaces/DUActionInterceptor.md CHANGED
@@ -22,4 +22,4 @@
22
22
 
23
23
  #### Source
24
24
 
25
- src/dataunit/DataUnit.ts:1894
25
+ src/dataunit/DataUnit.ts:1897
package/interfaces/PageRequest.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1999
17
+ src/dataunit/DataUnit.ts:2002
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1999
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:2000
27
+ src/dataunit/DataUnit.ts:2003
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:2000
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:2001
37
+ src/dataunit/DataUnit.ts:2004
package/interfaces/QuickFilter.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:2006
17
+ src/dataunit/DataUnit.ts:2009
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:2006
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:2007
27
+ src/dataunit/DataUnit.ts:2010
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:2007
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:2005
37
+ src/dataunit/DataUnit.ts:2008
package/interfaces/Record.md CHANGED
@@ -22,7 +22,7 @@
22
22
 
23
23
  #### Source
24
24
 
25
- src/dataunit/DataUnit.ts:1901
25
+ src/dataunit/DataUnit.ts:1904
26
26
 
27
27
  ***
28
28
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1901
32
32
 
33
33
  #### Source
34
34
 
35
- src/dataunit/DataUnit.ts:1900
35
+ src/dataunit/DataUnit.ts:1903
36
36
 
37
37
  ***
38
38
 
@@ -42,7 +42,7 @@ src/dataunit/DataUnit.ts:1900
42
42
 
43
43
  #### Source
44
44
 
45
- src/dataunit/DataUnit.ts:1898
45
+ src/dataunit/DataUnit.ts:1901
46
46
 
47
47
  ***
48
48
 
@@ -52,4 +52,4 @@ src/dataunit/DataUnit.ts:1898
52
52
 
53
53
  #### Source
54
54
 
55
- src/dataunit/DataUnit.ts:1899
55
+ src/dataunit/DataUnit.ts:1902
package/interfaces/SavedRecord.md CHANGED
@@ -18,7 +18,7 @@
18
18
 
19
19
  #### Source
20
20
 
21
- src/dataunit/DataUnit.ts:1906
21
+ src/dataunit/DataUnit.ts:1909
22
22
 
23
23
  ***
24
24
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1906
32
32
 
33
33
  #### Source
34
34
 
35
- src/dataunit/DataUnit.ts:1901
35
+ src/dataunit/DataUnit.ts:1904
36
36
 
37
37
  ***
38
38
 
@@ -46,7 +46,7 @@ src/dataunit/DataUnit.ts:1901
46
46
 
47
47
  #### Source
48
48
 
49
- src/dataunit/DataUnit.ts:1900
49
+ src/dataunit/DataUnit.ts:1903
50
50
 
51
51
  ***
52
52
 
@@ -60,7 +60,7 @@ src/dataunit/DataUnit.ts:1900
60
60
 
61
61
  #### Source
62
62
 
63
- src/dataunit/DataUnit.ts:1898
63
+ src/dataunit/DataUnit.ts:1901
64
64
 
65
65
  ***
66
66
 
@@ -74,4 +74,4 @@ src/dataunit/DataUnit.ts:1898
74
74
 
75
75
  #### Source
76
76
 
77
- src/dataunit/DataUnit.ts:1899
77
+ src/dataunit/DataUnit.ts:1902
package/interfaces/WaitingChange.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1994
17
+ src/dataunit/DataUnit.ts:1997
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1994
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1995
27
+ src/dataunit/DataUnit.ts:1998
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1995
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1993
37
+ src/dataunit/DataUnit.ts:1996
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/core-docs",
3
- "version": "0.0.0-feat-dev-KB-74304-3.2",
3
+ "version": "0.0.0-feat-dev-KB-79444.0",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [
package/type-aliases/DataUnitEventOptions.md CHANGED
@@ -14,4 +14,4 @@
14
14
 
15
15
  ## Source
16
16
 
17
- src/dataunit/DataUnit.ts:2076
17
+ src/dataunit/DataUnit.ts:2079