@sankhyalabs/core-docs 6.0.1 → 6.1.0-dev.2

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.
@@ -20,7 +20,7 @@
20
20
 
21
21
  ### compare()
22
22
 
23
- > `static` **compare**(`field`, `recordA`, `recordB`, `asc`): `number`
23
+ > `static` **compare**(`field`, `recordA`, `recordB`, `asc`, `onlyLabel`): `number`
24
24
 
25
25
  #### Parameters
26
26
 
@@ -32,6 +32,8 @@
32
32
 
33
33
  • **asc**: `boolean`= `true`
34
34
 
35
+ • **onlyLabel**: `boolean`= `false`
36
+
35
37
  #### Returns
36
38
 
37
39
  `number`
@@ -64,7 +66,7 @@ src/dataunit/sorting/FieldComparator.ts:19
64
66
 
65
67
  ### compareValues()
66
68
 
67
- > `static` **compareValues**(`descriptor`, `valueA`, `valueB`): `number`
69
+ > `static` **compareValues**(`descriptor`, `valueA`, `valueB`, `onlyLabel`): `number`
68
70
 
69
71
  #### Parameters
70
72
 
@@ -74,6 +76,8 @@ src/dataunit/sorting/FieldComparator.ts:19
74
76
 
75
77
  • **valueB**: `any`
76
78
 
79
+ • **onlyLabel**: `boolean`= `false`
80
+
77
81
  #### Returns
78
82
 
79
83
  `number`
@@ -28,7 +28,7 @@ opções para o gerenciamento de eventos de teclado.
28
28
 
29
29
  #### Source
30
30
 
31
- src/utils/KeyboardManager/index.ts:19
31
+ src/utils/KeyboardManager/index.ts:20
32
32
 
33
33
  ## Properties
34
34
 
@@ -38,7 +38,7 @@ src/utils/KeyboardManager/index.ts:19
38
38
 
39
39
  #### Source
40
40
 
41
- src/utils/KeyboardManager/index.ts:12
41
+ src/utils/KeyboardManager/index.ts:13
42
42
 
43
43
  ***
44
44
 
@@ -50,6 +50,16 @@ src/utils/KeyboardManager/index.ts:12
50
50
 
51
51
  src/utils/KeyboardManager/index.ts:11
52
52
 
53
+ ***
54
+
55
+ ### \_shadowRoots
56
+
57
+ > `private` **\_shadowRoots**: `ShadowRoot`[] = `[]`
58
+
59
+ #### Source
60
+
61
+ src/utils/KeyboardManager/index.ts:12
62
+
53
63
  ## Accessors
54
64
 
55
65
  ### mappedKeys
@@ -66,10 +76,30 @@ chaves mapeadas com descrições
66
76
 
67
77
  #### Source
68
78
 
69
- src/utils/KeyboardManager/index.ts:97
79
+ src/utils/KeyboardManager/index.ts:154
70
80
 
71
81
  ## Methods
72
82
 
83
+ ### addEventListenerToNestedShadowRoots()
84
+
85
+ > `private` **addEventListenerToNestedShadowRoots**(`event`, `callback`): `void`
86
+
87
+ #### Parameters
88
+
89
+ • **event**: `"keydown"` \| `"keyup"`
90
+
91
+ • **callback**: `VoidFunction`
92
+
93
+ #### Returns
94
+
95
+ `void`
96
+
97
+ #### Source
98
+
99
+ src/utils/KeyboardManager/index.ts:56
100
+
101
+ ***
102
+
73
103
  ### bind()
74
104
 
75
105
  > **bind**(`keyMap`, `callback`, `options`?): [`KeyboardManager`](KeyboardManager.md)
@@ -98,7 +128,7 @@ O objeto `KeyboardManager`
98
128
 
99
129
  #### Source
100
130
 
101
- src/utils/KeyboardManager/index.ts:37
131
+ src/utils/KeyboardManager/index.ts:76
102
132
 
103
133
  ***
104
134
 
@@ -126,7 +156,27 @@ Retorna se todas as teclas modificadoras foram aplicadas
126
156
 
127
157
  #### Source
128
158
 
129
- src/utils/KeyboardManager/index.ts:166
159
+ src/utils/KeyboardManager/index.ts:223
160
+
161
+ ***
162
+
163
+ ### findAllNestedShadowRoots()
164
+
165
+ > `private` **findAllNestedShadowRoots**(`element`, `results`): `ShadowRoot`[]
166
+
167
+ #### Parameters
168
+
169
+ • **element**: `Element` \| `Document` \| `HTMLElement` \| `ChildNode`
170
+
171
+ • **results**: `ShadowRoot`[]= `[]`
172
+
173
+ #### Returns
174
+
175
+ `ShadowRoot`[]
176
+
177
+ #### Source
178
+
179
+ src/utils/KeyboardManager/index.ts:35
130
180
 
131
181
  ***
132
182
 
@@ -160,7 +210,7 @@ O evento de teclado
160
210
 
161
211
  #### Source
162
212
 
163
- src/utils/KeyboardManager/index.ts:113
213
+ src/utils/KeyboardManager/index.ts:170
164
214
 
165
215
  ***
166
216
 
@@ -188,7 +238,27 @@ Retorna se o evento de teclado foi disparado e as teclas modificadoras aplicadas
188
238
 
189
239
  #### Source
190
240
 
191
- src/utils/KeyboardManager/index.ts:129
241
+ src/utils/KeyboardManager/index.ts:186
242
+
243
+ ***
244
+
245
+ ### removeEventListenerToNestedShadowRoots()
246
+
247
+ > `private` **removeEventListenerToNestedShadowRoots**(`event`, `callback`): `void`
248
+
249
+ #### Parameters
250
+
251
+ • **event**: `"keydown"` \| `"keyup"`
252
+
253
+ • **callback**: `VoidFunction`
254
+
255
+ #### Returns
256
+
257
+ `void`
258
+
259
+ #### Source
260
+
261
+ src/utils/KeyboardManager/index.ts:62
192
262
 
193
263
  ***
194
264
 
@@ -212,7 +282,27 @@ Chave de mapeamento de teclado.
212
282
 
213
283
  #### Source
214
284
 
215
- src/utils/KeyboardManager/index.ts:73
285
+ src/utils/KeyboardManager/index.ts:126
286
+
287
+ ***
288
+
289
+ ### unbindAllShortcutKeys()
290
+
291
+ > **unbindAllShortcutKeys**(`listShortcutKeys`?): `void`
292
+
293
+ Remove todos os eventos de teclado ou de uma lista informada
294
+
295
+ #### Parameters
296
+
297
+ • **listShortcutKeys?**: `string`[]
298
+
299
+ #### Returns
300
+
301
+ `void`
302
+
303
+ #### Source
304
+
305
+ src/utils/KeyboardManager/index.ts:115
216
306
 
217
307
  ***
218
308
 
@@ -238,4 +328,4 @@ Se o evento de teclado deve ser propagado
238
328
 
239
329
  #### Source
240
330
 
241
- src/utils/KeyboardManager/index.ts:202
331
+ src/utils/KeyboardManager/index.ts:259
@@ -144,7 +144,7 @@ Operação do contexto que o lock deve ser feito.
144
144
 
145
145
  #### Source
146
146
 
147
- src/utils/LockManager.ts:137
147
+ src/utils/LockManager.ts:136
148
148
 
149
149
  ***
150
150
 
@@ -172,7 +172,7 @@ Promise que será resolvida quando todos os locks forem resetados
172
172
 
173
173
  #### Source
174
174
 
175
- src/utils/LockManager.ts:111
175
+ src/utils/LockManager.ts:110
176
176
 
177
177
  ***
178
178
 
@@ -214,7 +214,7 @@ src/utils/LockManager.ts:69
214
214
 
215
215
  #### Source
216
216
 
217
- src/utils/LockManager.ts:191
217
+ src/utils/LockManager.ts:190
218
218
 
219
219
  ***
220
220
 
@@ -246,4 +246,4 @@ Operação do contexto que devera aguardar.
246
246
 
247
247
  #### Source
248
248
 
249
- src/utils/LockManager.ts:164
249
+ src/utils/LockManager.ts:163
@@ -120,7 +120,7 @@ Caminho da propriedade a ser buscada.
120
120
 
121
121
  #### Source
122
122
 
123
- src/utils/ObjectUtils.ts:140
123
+ src/utils/ObjectUtils.ts:161
124
124
 
125
125
  ***
126
126
 
@@ -193,6 +193,30 @@ src/utils/ObjectUtils.ts:119
193
193
 
194
194
  ***
195
195
 
196
+ ### isEmptySafetyCheck()
197
+
198
+ > `static` **isEmptySafetyCheck**(`obj`): `boolean`
199
+
200
+ Verifica se o objeto está vazio (sem atributos) e retorna true caso seja undefined ou null.
201
+
202
+ #### Parameters
203
+
204
+ • **obj**: `object`
205
+
206
+ Objeto a ser verificado.
207
+
208
+ #### Returns
209
+
210
+ `boolean`
211
+
212
+ - True caso o objeto esteja vazio.
213
+
214
+ #### Source
215
+
216
+ src/utils/ObjectUtils.ts:129
217
+
218
+ ***
219
+
196
220
  ### isNotEmpty()
197
221
 
198
222
  > `static` **isNotEmpty**(`obj`): `boolean`
@@ -213,7 +237,31 @@ Objeto a ser verificado.
213
237
 
214
238
  #### Source
215
239
 
216
- src/utils/ObjectUtils.ts:129
240
+ src/utils/ObjectUtils.ts:140
241
+
242
+ ***
243
+
244
+ ### isNotEmptySafetyCheck()
245
+
246
+ > `static` **isNotEmptySafetyCheck**(`obj`): `boolean`
247
+
248
+ Verifica se o objeto NÃO está vazio (sem atributos) e retorna false caso objeto seja null ou undefined.
249
+
250
+ #### Parameters
251
+
252
+ • **obj**: `object`
253
+
254
+ Objeto a ser verificado.
255
+
256
+ #### Returns
257
+
258
+ `boolean`
259
+
260
+ - True caso o objeto NÃO esteja vazio
261
+
262
+ #### Source
263
+
264
+ src/utils/ObjectUtils.ts:150
217
265
 
218
266
  ***
219
267
 
@@ -30,7 +30,7 @@
30
30
 
31
31
  #### Source
32
32
 
33
- src/dataunit/DataUnit.ts:2088
33
+ src/dataunit/DataUnit.ts:2136
34
34
 
35
35
  ## Properties
36
36
 
@@ -40,7 +40,7 @@ src/dataunit/DataUnit.ts:2088
40
40
 
41
41
  #### Source
42
42
 
43
- src/dataunit/DataUnit.ts:2085
43
+ src/dataunit/DataUnit.ts:2133
44
44
 
45
45
  ***
46
46
 
@@ -50,7 +50,7 @@ src/dataunit/DataUnit.ts:2085
50
50
 
51
51
  #### Source
52
52
 
53
- src/dataunit/DataUnit.ts:2086
53
+ src/dataunit/DataUnit.ts:2134
54
54
 
55
55
  ***
56
56
 
@@ -60,7 +60,7 @@ src/dataunit/DataUnit.ts:2086
60
60
 
61
61
  #### Source
62
62
 
63
- src/dataunit/DataUnit.ts:2082
63
+ src/dataunit/DataUnit.ts:2130
64
64
 
65
65
  ***
66
66
 
@@ -74,7 +74,7 @@ src/dataunit/DataUnit.ts:2082
74
74
 
75
75
  #### Source
76
76
 
77
- src/dataunit/DataUnit.ts:2084
77
+ src/dataunit/DataUnit.ts:2132
78
78
 
79
79
  ***
80
80
 
@@ -84,7 +84,7 @@ src/dataunit/DataUnit.ts:2084
84
84
 
85
85
  #### Source
86
86
 
87
- src/dataunit/DataUnit.ts:2081
87
+ src/dataunit/DataUnit.ts:2129
88
88
 
89
89
  ***
90
90
 
@@ -94,7 +94,7 @@ src/dataunit/DataUnit.ts:2081
94
94
 
95
95
  #### Source
96
96
 
97
- src/dataunit/DataUnit.ts:2083
97
+ src/dataunit/DataUnit.ts:2131
98
98
 
99
99
  ## Accessors
100
100
 
@@ -108,7 +108,7 @@ src/dataunit/DataUnit.ts:2083
108
108
 
109
109
  #### Source
110
110
 
111
- src/dataunit/DataUnit.ts:2116
111
+ src/dataunit/DataUnit.ts:2164
112
112
 
113
113
  ***
114
114
 
@@ -122,7 +122,7 @@ src/dataunit/DataUnit.ts:2116
122
122
 
123
123
  #### Source
124
124
 
125
- src/dataunit/DataUnit.ts:2106
125
+ src/dataunit/DataUnit.ts:2154
126
126
 
127
127
  ***
128
128
 
@@ -136,7 +136,7 @@ src/dataunit/DataUnit.ts:2106
136
136
 
137
137
  #### Source
138
138
 
139
- src/dataunit/DataUnit.ts:2096
139
+ src/dataunit/DataUnit.ts:2144
140
140
 
141
141
  ## Methods
142
142
 
@@ -150,7 +150,7 @@ src/dataunit/DataUnit.ts:2096
150
150
 
151
151
  #### Source
152
152
 
153
- src/dataunit/DataUnit.ts:2123
153
+ src/dataunit/DataUnit.ts:2171
154
154
 
155
155
  ***
156
156
 
@@ -164,4 +164,4 @@ src/dataunit/DataUnit.ts:2123
164
164
 
165
165
  #### Source
166
166
 
167
- src/dataunit/DataUnit.ts:2127
167
+ src/dataunit/DataUnit.ts:2175
@@ -96,7 +96,7 @@ String com valores alterados.
96
96
 
97
97
  #### Source
98
98
 
99
- src/utils/StringUtils.ts:548
99
+ src/utils/StringUtils.ts:552
100
100
 
101
101
  ***
102
102
 
@@ -155,7 +155,7 @@ src/utils/StringUtils.ts:381
155
155
 
156
156
  #### Source
157
157
 
158
- src/utils/StringUtils.ts:485
158
+ src/utils/StringUtils.ts:489
159
159
 
160
160
  ***
161
161
 
@@ -214,7 +214,7 @@ A string invertida
214
214
 
215
215
  #### Source
216
216
 
217
- src/utils/StringUtils.ts:416
217
+ src/utils/StringUtils.ts:419
218
218
 
219
219
  ***
220
220
 
@@ -232,7 +232,7 @@ src/utils/StringUtils.ts:416
232
232
 
233
233
  #### Source
234
234
 
235
- src/utils/StringUtils.ts:457
235
+ src/utils/StringUtils.ts:461
236
236
 
237
237
  ***
238
238
 
@@ -288,7 +288,7 @@ src/utils/StringUtils.ts:158
288
288
 
289
289
  #### Source
290
290
 
291
- src/utils/StringUtils.ts:489
291
+ src/utils/StringUtils.ts:493
292
292
 
293
293
  ***
294
294
 
@@ -361,7 +361,7 @@ Se a string é minúscula
361
361
 
362
362
  #### Source
363
363
 
364
- src/utils/StringUtils.ts:404
364
+ src/utils/StringUtils.ts:406
365
365
 
366
366
  ***
367
367
 
@@ -510,7 +510,7 @@ src/utils/StringUtils.ts:360
510
510
 
511
511
  #### Source
512
512
 
513
- src/utils/StringUtils.ts:476
513
+ src/utils/StringUtils.ts:480
514
514
 
515
515
  ***
516
516
 
@@ -561,7 +561,7 @@ src/utils/StringUtils.ts:124
561
561
 
562
562
  #### Source
563
563
 
564
- src/utils/StringUtils.ts:437
564
+ src/utils/StringUtils.ts:441
565
565
 
566
566
  ***
567
567
 
@@ -663,7 +663,7 @@ src/utils/StringUtils.ts:49
663
663
 
664
664
  #### Source
665
665
 
666
- src/utils/StringUtils.ts:467
666
+ src/utils/StringUtils.ts:471
667
667
 
668
668
  ***
669
669
 
@@ -707,7 +707,7 @@ src/utils/StringUtils.ts:325
707
707
 
708
708
  #### Source
709
709
 
710
- src/utils/StringUtils.ts:420
710
+ src/utils/StringUtils.ts:424
711
711
 
712
712
  ***
713
713