@sankhyalabs/core-docs 0.0.0-feat-dev-kb-63156.1 → 0.0.0-feat-dev-KB-80103.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.
Files changed (19) hide show
  1. package/classes/Change.md +11 -11
  2. package/classes/DataUnit.md +215 -117
  3. package/classes/LockManager.md +73 -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/globals.md +0 -1
  10. package/interfaces/DUActionInterceptor.md +1 -1
  11. package/interfaces/PageRequest.md +3 -3
  12. package/interfaces/PaginationInfo.md +12 -0
  13. package/interfaces/QuickFilter.md +3 -3
  14. package/interfaces/Record.md +4 -4
  15. package/interfaces/SavedRecord.md +5 -5
  16. package/interfaces/WaitingChange.md +3 -3
  17. package/package.json +1 -1
  18. package/type-aliases/DataUnitEventOptions.md +1 -1
  19. package/variables/CHANGING_PAGE_LOADING_SOURCE.md +0 -13
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/SelectionInfo.md CHANGED
@@ -30,7 +30,7 @@
30
30
 
31
31
  #### Source
32
32
 
33
- src/dataunit/DataUnit.ts:2035
33
+ src/dataunit/DataUnit.ts:2073
34
34
 
35
35
  ## Properties
36
36
 
@@ -40,7 +40,7 @@ src/dataunit/DataUnit.ts:2035
40
40
 
41
41
  #### Source
42
42
 
43
- src/dataunit/DataUnit.ts:2032
43
+ src/dataunit/DataUnit.ts:2070
44
44
 
45
45
  ***
46
46
 
@@ -50,7 +50,7 @@ src/dataunit/DataUnit.ts:2032
50
50
 
51
51
  #### Source
52
52
 
53
- src/dataunit/DataUnit.ts:2033
53
+ src/dataunit/DataUnit.ts:2071
54
54
 
55
55
  ***
56
56
 
@@ -60,7 +60,7 @@ src/dataunit/DataUnit.ts:2033
60
60
 
61
61
  #### Source
62
62
 
63
- src/dataunit/DataUnit.ts:2029
63
+ src/dataunit/DataUnit.ts:2067
64
64
 
65
65
  ***
66
66
 
@@ -74,7 +74,7 @@ src/dataunit/DataUnit.ts:2029
74
74
 
75
75
  #### Source
76
76
 
77
- src/dataunit/DataUnit.ts:2031
77
+ src/dataunit/DataUnit.ts:2069
78
78
 
79
79
  ***
80
80
 
@@ -84,7 +84,7 @@ src/dataunit/DataUnit.ts:2031
84
84
 
85
85
  #### Source
86
86
 
87
- src/dataunit/DataUnit.ts:2028
87
+ src/dataunit/DataUnit.ts:2066
88
88
 
89
89
  ***
90
90
 
@@ -94,7 +94,7 @@ src/dataunit/DataUnit.ts:2028
94
94
 
95
95
  #### Source
96
96
 
97
- src/dataunit/DataUnit.ts:2030
97
+ src/dataunit/DataUnit.ts:2068
98
98
 
99
99
  ## Accessors
100
100
 
@@ -108,7 +108,7 @@ src/dataunit/DataUnit.ts:2030
108
108
 
109
109
  #### Source
110
110
 
111
- src/dataunit/DataUnit.ts:2063
111
+ src/dataunit/DataUnit.ts:2101
112
112
 
113
113
  ***
114
114
 
@@ -122,7 +122,7 @@ src/dataunit/DataUnit.ts:2063
122
122
 
123
123
  #### Source
124
124
 
125
- src/dataunit/DataUnit.ts:2053
125
+ src/dataunit/DataUnit.ts:2091
126
126
 
127
127
  ***
128
128
 
@@ -136,7 +136,7 @@ src/dataunit/DataUnit.ts:2053
136
136
 
137
137
  #### Source
138
138
 
139
- src/dataunit/DataUnit.ts:2043
139
+ src/dataunit/DataUnit.ts:2081
140
140
 
141
141
  ## Methods
142
142
 
@@ -150,7 +150,7 @@ src/dataunit/DataUnit.ts:2043
150
150
 
151
151
  #### Source
152
152
 
153
- src/dataunit/DataUnit.ts:2070
153
+ src/dataunit/DataUnit.ts:2108
154
154
 
155
155
  ***
156
156
 
@@ -164,4 +164,4 @@ src/dataunit/DataUnit.ts:2070
164
164
 
165
165
  #### Source
166
166
 
167
- src/dataunit/DataUnit.ts:2074
167
+ src/dataunit/DataUnit.ts:2112
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:1914
17
+ src/dataunit/DataUnit.ts:1952
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1914
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1916
27
+ src/dataunit/DataUnit.ts:1954
28
28
 
29
29
  ***
30
30
 
@@ -34,7 +34,7 @@ src/dataunit/DataUnit.ts:1916
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1913
37
+ src/dataunit/DataUnit.ts:1951
38
38
 
39
39
  ***
40
40
 
@@ -44,4 +44,4 @@ src/dataunit/DataUnit.ts:1913
44
44
 
45
45
  #### Source
46
46
 
47
- src/dataunit/DataUnit.ts:1915
47
+ src/dataunit/DataUnit.ts:1953
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:2022
17
+ src/dataunit/DataUnit.ts:2060
18
18
 
19
19
  ***
20
20
 
@@ -24,4 +24,4 @@ src/dataunit/DataUnit.ts:2022
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:2023
27
+ src/dataunit/DataUnit.ts:2061
package/globals.md CHANGED
@@ -96,7 +96,6 @@
96
96
 
97
97
  ## Variables
98
98
 
99
- - [CHANGING\_PAGE\_LOADING\_SOURCE](variables/CHANGING_PAGE_LOADING_SOURCE.md)
100
99
  - [OVERFLOWED\_CLASS\_NAME](variables/OVERFLOWED_CLASS_NAME.md)
101
100
 
102
101
  ## Functions
package/interfaces/DUActionInterceptor.md CHANGED
@@ -22,4 +22,4 @@
22
22
 
23
23
  #### Source
24
24
 
25
- src/dataunit/DataUnit.ts:1897
25
+ src/dataunit/DataUnit.ts:1935
package/interfaces/PageRequest.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:2002
17
+ src/dataunit/DataUnit.ts:2040
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:2002
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:2003
27
+ src/dataunit/DataUnit.ts:2041
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:2003
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:2004
37
+ src/dataunit/DataUnit.ts:2042
package/interfaces/PaginationInfo.md CHANGED
@@ -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`
package/interfaces/QuickFilter.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:2009
17
+ src/dataunit/DataUnit.ts:2047
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:2009
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:2010
27
+ src/dataunit/DataUnit.ts:2048
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:2010
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:2008
37
+ src/dataunit/DataUnit.ts:2046
package/interfaces/Record.md CHANGED
@@ -22,7 +22,7 @@
22
22
 
23
23
  #### Source
24
24
 
25
- src/dataunit/DataUnit.ts:1904
25
+ src/dataunit/DataUnit.ts:1942
26
26
 
27
27
  ***
28
28
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1904
32
32
 
33
33
  #### Source
34
34
 
35
- src/dataunit/DataUnit.ts:1903
35
+ src/dataunit/DataUnit.ts:1941
36
36
 
37
37
  ***
38
38
 
@@ -42,7 +42,7 @@ src/dataunit/DataUnit.ts:1903
42
42
 
43
43
  #### Source
44
44
 
45
- src/dataunit/DataUnit.ts:1901
45
+ src/dataunit/DataUnit.ts:1939
46
46
 
47
47
  ***
48
48
 
@@ -52,4 +52,4 @@ src/dataunit/DataUnit.ts:1901
52
52
 
53
53
  #### Source
54
54
 
55
- src/dataunit/DataUnit.ts:1902
55
+ src/dataunit/DataUnit.ts:1940
package/interfaces/SavedRecord.md CHANGED
@@ -18,7 +18,7 @@
18
18
 
19
19
  #### Source
20
20
 
21
- src/dataunit/DataUnit.ts:1909
21
+ src/dataunit/DataUnit.ts:1947
22
22
 
23
23
  ***
24
24
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1909
32
32
 
33
33
  #### Source
34
34
 
35
- src/dataunit/DataUnit.ts:1904
35
+ src/dataunit/DataUnit.ts:1942
36
36
 
37
37
  ***
38
38
 
@@ -46,7 +46,7 @@ src/dataunit/DataUnit.ts:1904
46
46
 
47
47
  #### Source
48
48
 
49
- src/dataunit/DataUnit.ts:1903
49
+ src/dataunit/DataUnit.ts:1941
50
50
 
51
51
  ***
52
52
 
@@ -60,7 +60,7 @@ src/dataunit/DataUnit.ts:1903
60
60
 
61
61
  #### Source
62
62
 
63
- src/dataunit/DataUnit.ts:1901
63
+ src/dataunit/DataUnit.ts:1939
64
64
 
65
65
  ***
66
66
 
@@ -74,4 +74,4 @@ src/dataunit/DataUnit.ts:1901
74
74
 
75
75
  #### Source
76
76
 
77
- src/dataunit/DataUnit.ts:1902
77
+ src/dataunit/DataUnit.ts:1940
package/interfaces/WaitingChange.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1997
17
+ src/dataunit/DataUnit.ts:2035
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1997
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1998
27
+ src/dataunit/DataUnit.ts:2036
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1998
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1996
37
+ src/dataunit/DataUnit.ts:2034
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/core-docs",
3
- "version": "0.0.0-feat-dev-kb-63156.1",
3
+ "version": "0.0.0-feat-dev-KB-80103.1",
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:2079
17
+ src/dataunit/DataUnit.ts:2117
package/variables/CHANGING_PAGE_LOADING_SOURCE.md DELETED
@@ -1,13 +0,0 @@
1
- [**@sankhyalabs/core**](../README.md) • **Docs**
2
-
3
- ***
4
-
5
- [@sankhyalabs/core](../globals.md) / CHANGING\_PAGE\_LOADING\_SOURCE
6
-
7
- # Variable: CHANGING\_PAGE\_LOADING\_SOURCE
8
-
9
- > `const` **CHANGING\_PAGE\_LOADING\_SOURCE**: `"CHANGING_PAGE_LOADING_SOURCE"` = `"CHANGING_PAGE_LOADING_SOURCE"`
10
-
11
- ## Source
12
-
13
- src/dataunit/DataUnit.ts:33