@sankhyalabs/core-docs 5.20.0-rc.29 → 5.20.0-rc.30

Sign up to get free protection for your applications and to get access to all the features.
Files changed (17) hide show
  1. package/classes/Change.md +11 -11
  2. package/classes/DataUnit.md +135 -135
  3. package/classes/LockManager.md +191 -0
  4. package/classes/SelectionInfo.md +12 -12
  5. package/classes/SilentException.md +193 -0
  6. package/enumerations/ChangeOperation.md +4 -4
  7. package/enumerations/LockManagerOperation.md +21 -0
  8. package/enumerations/SelectionMode.md +2 -2
  9. package/globals.md +3 -0
  10. package/interfaces/DUActionInterceptor.md +1 -1
  11. package/interfaces/PageRequest.md +3 -3
  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 ADDED
@@ -0,0 +1,191 @@
1
+ [**@sankhyalabs/core**](../README.md) • **Docs**
2
+
3
+ ***
4
+
5
+ [@sankhyalabs/core](../globals.md) / LockManager
6
+
7
+ # Class: LockManager
8
+
9
+ ## Constructors
10
+
11
+ ### new LockManager()
12
+
13
+ > **new LockManager**(): [`LockManager`](LockManager.md)
14
+
15
+ #### Returns
16
+
17
+ [`LockManager`](LockManager.md)
18
+
19
+ ## Properties
20
+
21
+ ### ATTRIBUTE\_NAME
22
+
23
+ > `static` **ATTRIBUTE\_NAME**: `string` = `"data-locker-manger-context-id"`
24
+
25
+ Nome do atributo que será utilizado para controlar contexto de locks nos elementos da DOM.
26
+
27
+ #### Source
28
+
29
+ src/utils/LockManager.ts:24
30
+
31
+ ***
32
+
33
+ ### \_locks
34
+
35
+ > `static` `private` **\_locks**: `Map`\<`string`, `Lock`[]\>
36
+
37
+ #### Source
38
+
39
+ src/utils/LockManager.ts:19
40
+
41
+ ## Methods
42
+
43
+ ### addLockManagerCtxId()
44
+
45
+ > `static` **addLockManagerCtxId**(`startElement`): `string`
46
+
47
+ Cria um contexto de locker, caso nao exista, para todos elementos pais iniciados com ez- ou snk-.
48
+
49
+ #### Parameters
50
+
51
+ • **startElement**: `HTMLElement`
52
+
53
+ Elemento de de onde o lock deve começar.
54
+
55
+ #### Returns
56
+
57
+ `string`
58
+
59
+ - O id do locker, que pode ser usado para iniciar ou aguardar um lock do contexto.
60
+
61
+ #### Source
62
+
63
+ src/utils/LockManager.ts:83
64
+
65
+ ***
66
+
67
+ ### buildContextID()
68
+
69
+ > `static` `private` **buildContextID**(): `string`
70
+
71
+ #### Returns
72
+
73
+ `string`
74
+
75
+ #### Source
76
+
77
+ src/utils/LockManager.ts:26
78
+
79
+ ***
80
+
81
+ ### buildLockerID()
82
+
83
+ > `static` `private` **buildLockerID**(`ctxId`, `operation`): `undefined` \| `string`
84
+
85
+ #### Parameters
86
+
87
+ • **ctxId**: `string` \| `HTMLElement`
88
+
89
+ • **operation**: [`TASKBAR_CLICK`](../enumerations/LockManagerOperation.md#taskbar_click)
90
+
91
+ #### Returns
92
+
93
+ `undefined` \| `string`
94
+
95
+ #### Source
96
+
97
+ src/utils/LockManager.ts:30
98
+
99
+ ***
100
+
101
+ ### findExistingCtxId()
102
+
103
+ > `static` `private` **findExistingCtxId**(`element`): `null` \| `string`
104
+
105
+ #### Parameters
106
+
107
+ • **element**: `HTMLElement`
108
+
109
+ #### Returns
110
+
111
+ `null` \| `string`
112
+
113
+ #### Source
114
+
115
+ src/utils/LockManager.ts:43
116
+
117
+ ***
118
+
119
+ ### lock()
120
+
121
+ > `static` **lock**(`id`, `operation`): `any`
122
+
123
+ Inicia um locker baseado em um contexto e uma operação.
124
+
125
+ #### Parameters
126
+
127
+ • **id**: `string` \| `HTMLElement`
128
+
129
+ Pode ser um ID do contexto de locker, ou, o elemento contendo um contexto de locker.
130
+
131
+ • **operation**: [`TASKBAR_CLICK`](../enumerations/LockManagerOperation.md#taskbar_click)
132
+
133
+ Operação do contexto que o lock deve ser feito.
134
+
135
+ #### Returns
136
+
137
+ `any`
138
+
139
+ - Uma função que fara a liberação do lock.
140
+
141
+ #### Source
142
+
143
+ src/utils/LockManager.ts:114
144
+
145
+ ***
146
+
147
+ ### traverseAndAddAttr()
148
+
149
+ > `static` `private` **traverseAndAddAttr**(`element`, `ctxId`): `void`
150
+
151
+ #### Parameters
152
+
153
+ • **element**: `HTMLElement`
154
+
155
+ • **ctxId**: `string`
156
+
157
+ #### Returns
158
+
159
+ `void`
160
+
161
+ #### Source
162
+
163
+ src/utils/LockManager.ts:65
164
+
165
+ ***
166
+
167
+ ### whenResolve()
168
+
169
+ > `static` **whenResolve**(`id`, `operation`): `Promise`\<`void`\>
170
+
171
+ Aguarda todos os lockers de um contexto e operação serem resolvidos.
172
+
173
+ #### Parameters
174
+
175
+ • **id**: `string` \| `HTMLElement`
176
+
177
+ Pode ser um ID do contexto de locker, ou, o elemento contendo um contexto de locker.
178
+
179
+ • **operation**: [`TASKBAR_CLICK`](../enumerations/LockManagerOperation.md#taskbar_click)
180
+
181
+ Operação do contexto que devera aguardar.
182
+
183
+ #### Returns
184
+
185
+ `Promise`\<`void`\>
186
+
187
+ - Promise que será resolvida quando todos lockers forem finalizados.
188
+
189
+ #### Source
190
+
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:2027
33
+ src/dataunit/DataUnit.ts:2030
34
34
 
35
35
  ## Properties
36
36
 
@@ -40,7 +40,7 @@ src/dataunit/DataUnit.ts:2027
40
40
 
41
41
  #### Source
42
42
 
43
- src/dataunit/DataUnit.ts:2024
43
+ src/dataunit/DataUnit.ts:2027
44
44
 
45
45
  ***
46
46
 
@@ -50,7 +50,7 @@ src/dataunit/DataUnit.ts:2024
50
50
 
51
51
  #### Source
52
52
 
53
- src/dataunit/DataUnit.ts:2025
53
+ src/dataunit/DataUnit.ts:2028
54
54
 
55
55
  ***
56
56
 
@@ -60,7 +60,7 @@ src/dataunit/DataUnit.ts:2025
60
60
 
61
61
  #### Source
62
62
 
63
- src/dataunit/DataUnit.ts:2021
63
+ src/dataunit/DataUnit.ts:2024
64
64
 
65
65
  ***
66
66
 
@@ -74,7 +74,7 @@ src/dataunit/DataUnit.ts:2021
74
74
 
75
75
  #### Source
76
76
 
77
- src/dataunit/DataUnit.ts:2023
77
+ src/dataunit/DataUnit.ts:2026
78
78
 
79
79
  ***
80
80
 
@@ -84,7 +84,7 @@ src/dataunit/DataUnit.ts:2023
84
84
 
85
85
  #### Source
86
86
 
87
- src/dataunit/DataUnit.ts:2020
87
+ src/dataunit/DataUnit.ts:2023
88
88
 
89
89
  ***
90
90
 
@@ -94,7 +94,7 @@ src/dataunit/DataUnit.ts:2020
94
94
 
95
95
  #### Source
96
96
 
97
- src/dataunit/DataUnit.ts:2022
97
+ src/dataunit/DataUnit.ts:2025
98
98
 
99
99
  ## Accessors
100
100
 
@@ -108,7 +108,7 @@ src/dataunit/DataUnit.ts:2022
108
108
 
109
109
  #### Source
110
110
 
111
- src/dataunit/DataUnit.ts:2055
111
+ src/dataunit/DataUnit.ts:2058
112
112
 
113
113
  ***
114
114
 
@@ -122,7 +122,7 @@ src/dataunit/DataUnit.ts:2055
122
122
 
123
123
  #### Source
124
124
 
125
- src/dataunit/DataUnit.ts:2045
125
+ src/dataunit/DataUnit.ts:2048
126
126
 
127
127
  ***
128
128
 
@@ -136,7 +136,7 @@ src/dataunit/DataUnit.ts:2045
136
136
 
137
137
  #### Source
138
138
 
139
- src/dataunit/DataUnit.ts:2035
139
+ src/dataunit/DataUnit.ts:2038
140
140
 
141
141
  ## Methods
142
142
 
@@ -150,7 +150,7 @@ src/dataunit/DataUnit.ts:2035
150
150
 
151
151
  #### Source
152
152
 
153
- src/dataunit/DataUnit.ts:2062
153
+ src/dataunit/DataUnit.ts:2065
154
154
 
155
155
  ***
156
156
 
@@ -164,4 +164,4 @@ src/dataunit/DataUnit.ts:2062
164
164
 
165
165
  #### Source
166
166
 
167
- src/dataunit/DataUnit.ts:2066
167
+ src/dataunit/DataUnit.ts:2069
package/classes/SilentException.md ADDED
@@ -0,0 +1,193 @@
1
+ [**@sankhyalabs/core**](../README.md) • **Docs**
2
+
3
+ ***
4
+
5
+ [@sankhyalabs/core](../globals.md) / SilentException
6
+
7
+ # Class: SilentException
8
+
9
+ `SilentException`: Exceção lançada quando uma exception silenciosa é.
10
+
11
+ ## Extends
12
+
13
+ - `Error`
14
+
15
+ ## Constructors
16
+
17
+ ### new SilentException()
18
+
19
+ > **new SilentException**(`title`, `message`, `errorCode`): [`SilentException`](SilentException.md)
20
+
21
+ #### Parameters
22
+
23
+ • **title**: `string`= `""`
24
+
25
+ • **message**: `string`= `""`
26
+
27
+ • **errorCode**: `string`= `""`
28
+
29
+ #### Returns
30
+
31
+ [`SilentException`](SilentException.md)
32
+
33
+ #### Overrides
34
+
35
+ `Error.constructor`
36
+
37
+ #### Source
38
+
39
+ src/exceptions/SilentException.ts:18
40
+
41
+ ## Properties
42
+
43
+ ### cause?
44
+
45
+ > `optional` **cause**: `unknown`
46
+
47
+ #### Inherited from
48
+
49
+ `Error.cause`
50
+
51
+ #### Source
52
+
53
+ node\_modules/typescript/lib/lib.es2022.error.d.ts:26
54
+
55
+ ***
56
+
57
+ ### errorCode
58
+
59
+ > **errorCode**: `string`
60
+
61
+ Código do erro, indica o erro disparado pelo backend.
62
+
63
+ #### Source
64
+
65
+ src/exceptions/SilentException.ts:16
66
+
67
+ ***
68
+
69
+ ### message
70
+
71
+ > **message**: `string`
72
+
73
+ Descrição do erro.
74
+
75
+ #### Overrides
76
+
77
+ `Error.message`
78
+
79
+ #### Source
80
+
81
+ src/exceptions/SilentException.ts:13
82
+
83
+ ***
84
+
85
+ ### name
86
+
87
+ > **name**: `string`
88
+
89
+ Nome da exceção.
90
+
91
+ #### Overrides
92
+
93
+ `Error.name`
94
+
95
+ #### Source
96
+
97
+ src/exceptions/SilentException.ts:7
98
+
99
+ ***
100
+
101
+ ### stack?
102
+
103
+ > `optional` **stack**: `string`
104
+
105
+ #### Inherited from
106
+
107
+ `Error.stack`
108
+
109
+ #### Source
110
+
111
+ node\_modules/typescript/lib/lib.es5.d.ts:1055
112
+
113
+ ***
114
+
115
+ ### title
116
+
117
+ > **title**: `string`
118
+
119
+ Titulo do erro.
120
+
121
+ #### Source
122
+
123
+ src/exceptions/SilentException.ts:10
124
+
125
+ ***
126
+
127
+ ### prepareStackTrace()?
128
+
129
+ > `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any`
130
+
131
+ Optional override for formatting stack traces
132
+
133
+ #### See
134
+
135
+ https://v8.dev/docs/stack-trace-api#customizing-stack-traces
136
+
137
+ #### Parameters
138
+
139
+ • **err**: `Error`
140
+
141
+ • **stackTraces**: `CallSite`[]
142
+
143
+ #### Returns
144
+
145
+ `any`
146
+
147
+ #### Inherited from
148
+
149
+ `Error.prepareStackTrace`
150
+
151
+ #### Source
152
+
153
+ node\_modules/@types/node/globals.d.ts:27
154
+
155
+ ***
156
+
157
+ ### stackTraceLimit
158
+
159
+ > `static` **stackTraceLimit**: `number`
160
+
161
+ #### Inherited from
162
+
163
+ `Error.stackTraceLimit`
164
+
165
+ #### Source
166
+
167
+ node\_modules/@types/node/globals.d.ts:29
168
+
169
+ ## Methods
170
+
171
+ ### captureStackTrace()
172
+
173
+ > `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void`
174
+
175
+ Create .stack property on a target object
176
+
177
+ #### Parameters
178
+
179
+ • **targetObject**: `object`
180
+
181
+ • **constructorOpt?**: `Function`
182
+
183
+ #### Returns
184
+
185
+ `void`
186
+
187
+ #### Inherited from
188
+
189
+ `Error.captureStackTrace`
190
+
191
+ #### Source
192
+
193
+ node\_modules/@types/node/globals.d.ts:20
package/enumerations/ChangeOperation.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1906
17
+ src/dataunit/DataUnit.ts:1909
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1906
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1908
27
+ src/dataunit/DataUnit.ts:1911
28
28
 
29
29
  ***
30
30
 
@@ -34,7 +34,7 @@ src/dataunit/DataUnit.ts:1908
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1905
37
+ src/dataunit/DataUnit.ts:1908
38
38
 
39
39
  ***
40
40
 
@@ -44,4 +44,4 @@ src/dataunit/DataUnit.ts:1905
44
44
 
45
45
  #### Source
46
46
 
47
- src/dataunit/DataUnit.ts:1907
47
+ src/dataunit/DataUnit.ts:1910
package/enumerations/LockManagerOperation.md ADDED
@@ -0,0 +1,21 @@
1
+ [**@sankhyalabs/core**](../README.md) • **Docs**
2
+
3
+ ***
4
+
5
+ [@sankhyalabs/core](../globals.md) / LockManagerOperation
6
+
7
+ # Enumeration: LockManagerOperation
8
+
9
+ Define os tipos de operação que o locker pode controlar
10
+
11
+ ## Enumeration Members
12
+
13
+ ### TASKBAR\_CLICK
14
+
15
+ > **TASKBAR\_CLICK**: `"taskbar_click"`
16
+
17
+ Operação de lock utilizada para controlar cliques nos botoes da taskbar.
18
+
19
+ #### Source
20
+
21
+ src/utils/LockManager.ts:9
package/enumerations/SelectionMode.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:2014
17
+ src/dataunit/DataUnit.ts:2017
18
18
 
19
19
  ***
20
20
 
@@ -24,4 +24,4 @@ src/dataunit/DataUnit.ts:2014
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:2015
27
+ src/dataunit/DataUnit.ts:2018
package/globals.md CHANGED
@@ -14,6 +14,7 @@
14
14
  - [ChangeOperation](enumerations/ChangeOperation.md)
15
15
  - [DataType](enumerations/DataType.md)
16
16
  - [DependencyType](enumerations/DependencyType.md)
17
+ - [LockManagerOperation](enumerations/LockManagerOperation.md)
17
18
  - [OverflowDirection](enumerations/OverflowDirection.md)
18
19
  - [SelectionMode](enumerations/SelectionMode.md)
19
20
  - [SortMode](enumerations/SortMode.md)
@@ -39,6 +40,7 @@
39
40
  - [IDBRepository](classes/IDBRepository.md)
40
41
  - [JSUtils](classes/JSUtils.md)
41
42
  - [KeyboardManager](classes/KeyboardManager.md)
43
+ - [LockManager](classes/LockManager.md)
42
44
  - [MaskFormatter](classes/MaskFormatter.md)
43
45
  - [NumberUtils](classes/NumberUtils.md)
44
46
  - [ObjectUtils](classes/ObjectUtils.md)
@@ -50,6 +52,7 @@
50
52
  - [SearchUtils](classes/SearchUtils.md)
51
53
  - [SelectionInfo](classes/SelectionInfo.md)
52
54
  - [ServiceCanceledException](classes/ServiceCanceledException.md)
55
+ - [SilentException](classes/SilentException.md)
53
56
  - [SkwHttpProvider](classes/SkwHttpProvider.md)
54
57
  - [StringUtils](classes/StringUtils.md)
55
58
  - [TimeFormatter](classes/TimeFormatter.md)
package/interfaces/DUActionInterceptor.md CHANGED
@@ -22,4 +22,4 @@
22
22
 
23
23
  #### Source
24
24
 
25
- src/dataunit/DataUnit.ts:1889
25
+ src/dataunit/DataUnit.ts:1892
package/interfaces/PageRequest.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:1996
37
+ src/dataunit/DataUnit.ts:1999
package/interfaces/QuickFilter.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:2001
17
+ src/dataunit/DataUnit.ts:2004
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:2001
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:2002
27
+ src/dataunit/DataUnit.ts:2005
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:2002
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:2000
37
+ src/dataunit/DataUnit.ts:2003
package/interfaces/Record.md CHANGED
@@ -22,7 +22,7 @@
22
22
 
23
23
  #### Source
24
24
 
25
- src/dataunit/DataUnit.ts:1896
25
+ src/dataunit/DataUnit.ts:1899
26
26
 
27
27
  ***
28
28
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1896
32
32
 
33
33
  #### Source
34
34
 
35
- src/dataunit/DataUnit.ts:1895
35
+ src/dataunit/DataUnit.ts:1898
36
36
 
37
37
  ***
38
38
 
@@ -42,7 +42,7 @@ src/dataunit/DataUnit.ts:1895
42
42
 
43
43
  #### Source
44
44
 
45
- src/dataunit/DataUnit.ts:1893
45
+ src/dataunit/DataUnit.ts:1896
46
46
 
47
47
  ***
48
48
 
@@ -52,4 +52,4 @@ src/dataunit/DataUnit.ts:1893
52
52
 
53
53
  #### Source
54
54
 
55
- src/dataunit/DataUnit.ts:1894
55
+ src/dataunit/DataUnit.ts:1897
package/interfaces/SavedRecord.md CHANGED
@@ -18,7 +18,7 @@
18
18
 
19
19
  #### Source
20
20
 
21
- src/dataunit/DataUnit.ts:1901
21
+ src/dataunit/DataUnit.ts:1904
22
22
 
23
23
  ***
24
24
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1901
32
32
 
33
33
  #### Source
34
34
 
35
- src/dataunit/DataUnit.ts:1896
35
+ src/dataunit/DataUnit.ts:1899
36
36
 
37
37
  ***
38
38
 
@@ -46,7 +46,7 @@ src/dataunit/DataUnit.ts:1896
46
46
 
47
47
  #### Source
48
48
 
49
- src/dataunit/DataUnit.ts:1895
49
+ src/dataunit/DataUnit.ts:1898
50
50
 
51
51
  ***
52
52
 
@@ -60,7 +60,7 @@ src/dataunit/DataUnit.ts:1895
60
60
 
61
61
  #### Source
62
62
 
63
- src/dataunit/DataUnit.ts:1893
63
+ src/dataunit/DataUnit.ts:1896
64
64
 
65
65
  ***
66
66
 
@@ -74,4 +74,4 @@ src/dataunit/DataUnit.ts:1893
74
74
 
75
75
  #### Source
76
76
 
77
- src/dataunit/DataUnit.ts:1894
77
+ src/dataunit/DataUnit.ts:1897