@sankhyalabs/core-docs 0.0.0-feat-dev-KB-80103.0 → 0.0.0-feat-dev-KB-74304.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 (17) hide show
  1. package/classes/Change.md +11 -11
  2. package/classes/DataUnit.md +117 -151
  3. package/classes/LockManager.md +87 -15
  4. package/classes/SelectionInfo.md +12 -12
  5. package/classes/UserAgentUtils.md +15 -1
  6. package/enumerations/ChangeOperation.md +4 -4
  7. package/enumerations/LockManagerOperation.md +12 -0
  8. package/enumerations/SelectionMode.md +2 -2
  9. package/interfaces/DUActionInterceptor.md +1 -1
  10. package/interfaces/PageRequest.md +3 -3
  11. package/interfaces/PaginationInfo.md +0 -12
  12. package/interfaces/QuickFilter.md +3 -3
  13. package/interfaces/Record.md +4 -4
  14. package/interfaces/SavedRecord.md +5 -5
  15. package/interfaces/WaitingChange.md +3 -3
  16. package/package.json +1 -1
  17. 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: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,27 @@ 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
+
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`): `any`
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**: [`TASKBAR_CLICK`](../enumerations/LockManagerOperation.md#taskbar_click)
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
- `any`
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:114
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:65
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**: [`TASKBAR_CLICK`](../enumerations/LockManagerOperation.md#taskbar_click)
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:142
263
+ src/utils/LockManager.ts:179
package/classes/SelectionInfo.md CHANGED
@@ -30,7 +30,7 @@
30
30
 
31
31
  #### Source
32
32
 
33
- src/dataunit/DataUnit.ts:2052
33
+ src/dataunit/DataUnit.ts:2035
34
34
 
35
35
  ## Properties
36
36
 
@@ -40,7 +40,7 @@ src/dataunit/DataUnit.ts:2052
40
40
 
41
41
  #### Source
42
42
 
43
- src/dataunit/DataUnit.ts:2049
43
+ src/dataunit/DataUnit.ts:2032
44
44
 
45
45
  ***
46
46
 
@@ -50,7 +50,7 @@ src/dataunit/DataUnit.ts:2049
50
50
 
51
51
  #### Source
52
52
 
53
- src/dataunit/DataUnit.ts:2050
53
+ src/dataunit/DataUnit.ts:2033
54
54
 
55
55
  ***
56
56
 
@@ -60,7 +60,7 @@ src/dataunit/DataUnit.ts:2050
60
60
 
61
61
  #### Source
62
62
 
63
- src/dataunit/DataUnit.ts:2046
63
+ src/dataunit/DataUnit.ts:2029
64
64
 
65
65
  ***
66
66
 
@@ -74,7 +74,7 @@ src/dataunit/DataUnit.ts:2046
74
74
 
75
75
  #### Source
76
76
 
77
- src/dataunit/DataUnit.ts:2048
77
+ src/dataunit/DataUnit.ts:2031
78
78
 
79
79
  ***
80
80
 
@@ -84,7 +84,7 @@ src/dataunit/DataUnit.ts:2048
84
84
 
85
85
  #### Source
86
86
 
87
- src/dataunit/DataUnit.ts:2045
87
+ src/dataunit/DataUnit.ts:2028
88
88
 
89
89
  ***
90
90
 
@@ -94,7 +94,7 @@ src/dataunit/DataUnit.ts:2045
94
94
 
95
95
  #### Source
96
96
 
97
- src/dataunit/DataUnit.ts:2047
97
+ src/dataunit/DataUnit.ts:2030
98
98
 
99
99
  ## Accessors
100
100
 
@@ -108,7 +108,7 @@ src/dataunit/DataUnit.ts:2047
108
108
 
109
109
  #### Source
110
110
 
111
- src/dataunit/DataUnit.ts:2080
111
+ src/dataunit/DataUnit.ts:2063
112
112
 
113
113
  ***
114
114
 
@@ -122,7 +122,7 @@ src/dataunit/DataUnit.ts:2080
122
122
 
123
123
  #### Source
124
124
 
125
- src/dataunit/DataUnit.ts:2070
125
+ src/dataunit/DataUnit.ts:2053
126
126
 
127
127
  ***
128
128
 
@@ -136,7 +136,7 @@ src/dataunit/DataUnit.ts:2070
136
136
 
137
137
  #### Source
138
138
 
139
- src/dataunit/DataUnit.ts:2060
139
+ src/dataunit/DataUnit.ts:2043
140
140
 
141
141
  ## Methods
142
142
 
@@ -150,7 +150,7 @@ src/dataunit/DataUnit.ts:2060
150
150
 
151
151
  #### Source
152
152
 
153
- src/dataunit/DataUnit.ts:2087
153
+ src/dataunit/DataUnit.ts:2070
154
154
 
155
155
  ***
156
156
 
@@ -164,4 +164,4 @@ src/dataunit/DataUnit.ts:2087
164
164
 
165
165
  #### Source
166
166
 
167
- src/dataunit/DataUnit.ts:2091
167
+ src/dataunit/DataUnit.ts:2074
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/ChangeOperation.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1931
17
+ src/dataunit/DataUnit.ts:1914
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1931
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1933
27
+ src/dataunit/DataUnit.ts:1916
28
28
 
29
29
  ***
30
30
 
@@ -34,7 +34,7 @@ src/dataunit/DataUnit.ts:1933
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1930
37
+ src/dataunit/DataUnit.ts:1913
38
38
 
39
39
  ***
40
40
 
@@ -44,4 +44,4 @@ src/dataunit/DataUnit.ts:1930
44
44
 
45
45
  #### Source
46
46
 
47
- src/dataunit/DataUnit.ts:1932
47
+ src/dataunit/DataUnit.ts:1915
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/enumerations/SelectionMode.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:2039
17
+ src/dataunit/DataUnit.ts:2022
18
18
 
19
19
  ***
20
20
 
@@ -24,4 +24,4 @@ src/dataunit/DataUnit.ts:2039
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:2040
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:1914
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:2019
17
+ src/dataunit/DataUnit.ts:2002
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:2019
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:2020
27
+ src/dataunit/DataUnit.ts:2003
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:2020
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:2021
37
+ src/dataunit/DataUnit.ts:2004
package/interfaces/PaginationInfo.md CHANGED
@@ -10,18 +10,6 @@ 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
-
25
13
  ### count?
26
14
 
27
15
  > `optional` **count**: `number`
package/interfaces/QuickFilter.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:2026
17
+ src/dataunit/DataUnit.ts:2009
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:2026
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:2027
27
+ src/dataunit/DataUnit.ts:2010
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:2027
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:2025
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:1921
25
+ src/dataunit/DataUnit.ts:1904
26
26
 
27
27
  ***
28
28
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1921
32
32
 
33
33
  #### Source
34
34
 
35
- src/dataunit/DataUnit.ts:1920
35
+ src/dataunit/DataUnit.ts:1903
36
36
 
37
37
  ***
38
38
 
@@ -42,7 +42,7 @@ src/dataunit/DataUnit.ts:1920
42
42
 
43
43
  #### Source
44
44
 
45
- src/dataunit/DataUnit.ts:1918
45
+ src/dataunit/DataUnit.ts:1901
46
46
 
47
47
  ***
48
48
 
@@ -52,4 +52,4 @@ src/dataunit/DataUnit.ts:1918
52
52
 
53
53
  #### Source
54
54
 
55
- src/dataunit/DataUnit.ts:1919
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:1926
21
+ src/dataunit/DataUnit.ts:1909
22
22
 
23
23
  ***
24
24
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1926
32
32
 
33
33
  #### Source
34
34
 
35
- src/dataunit/DataUnit.ts:1921
35
+ src/dataunit/DataUnit.ts:1904
36
36
 
37
37
  ***
38
38
 
@@ -46,7 +46,7 @@ src/dataunit/DataUnit.ts:1921
46
46
 
47
47
  #### Source
48
48
 
49
- src/dataunit/DataUnit.ts:1920
49
+ src/dataunit/DataUnit.ts:1903
50
50
 
51
51
  ***
52
52
 
@@ -60,7 +60,7 @@ src/dataunit/DataUnit.ts:1920
60
60
 
61
61
  #### Source
62
62
 
63
- src/dataunit/DataUnit.ts:1918
63
+ src/dataunit/DataUnit.ts:1901
64
64
 
65
65
  ***
66
66
 
@@ -74,4 +74,4 @@ src/dataunit/DataUnit.ts:1918
74
74
 
75
75
  #### Source
76
76
 
77
- src/dataunit/DataUnit.ts:1919
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:2014
17
+ src/dataunit/DataUnit.ts:1997
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:2014
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:2015
27
+ src/dataunit/DataUnit.ts:1998
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:2015
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:2013
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-80103.0",
3
+ "version": "0.0.0-feat-dev-KB-74304.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:2096
17
+ src/dataunit/DataUnit.ts:2079