@sankhyalabs/core-docs 0.0.0-feat-dev-KB-25740.0 → 0.0.0-feat-dev-KB-28409.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.
@@ -13,7 +13,12 @@
13
13
  ### Methods
14
14
 
15
15
  - [applyStringFilter](ArrayUtils.md#applystringfilter)
16
+ - [find](ArrayUtils.md#find)
17
+ - [indexOf](ArrayUtils.md#indexof)
18
+ - [isIn](ArrayUtils.md#isin)
16
19
  - [normalizeSearchString](ArrayUtils.md#normalizesearchstring)
20
+ - [removeAtIndex](ArrayUtils.md#removeatindex)
21
+ - [removeReference](ArrayUtils.md#removereference)
17
22
  - [sortAlphabetically](ArrayUtils.md#sortalphabetically)
18
23
 
19
24
  ## Constructors
@@ -47,7 +52,82 @@ Filtra um array a partir de um critério textual.
47
52
 
48
53
  #### Defined in
49
54
 
50
- src/utils/ArrayUtils.ts:17
55
+ src/utils/ArrayUtils.ts:18
56
+
57
+ ___
58
+
59
+ ### find
60
+
61
+ ▸ `Static` **find**(`arr`, `checkerFn`): `any`
62
+
63
+ Ordena valores de um array alfabeticamente.
64
+
65
+ #### Parameters
66
+
67
+ | Name | Type | Description |
68
+ | :------ | :------ | :------ |
69
+ | `arr` | `any` | Array a ser ordenado. |
70
+ | `checkerFn` | `any` | - |
71
+
72
+ #### Returns
73
+
74
+ `any`
75
+
76
+ - Array ordenado alfabeticamente..
77
+
78
+ #### Defined in
79
+
80
+ src/utils/ArrayUtils.ts:69
81
+
82
+ ___
83
+
84
+ ### indexOf
85
+
86
+ ▸ `Static` **indexOf**(`arr`, `obj`): `number`
87
+
88
+ Retorna o objeto se for encontrado no array, ou -1 se não for encontrado.
89
+
90
+ #### Parameters
91
+
92
+ | Name | Type | Description |
93
+ | :------ | :------ | :------ |
94
+ | `arr` | `any` | Array onde está o objeto. |
95
+ | `obj` | `any` | Objeto a ser procurado. |
96
+
97
+ #### Returns
98
+
99
+ `number`
100
+
101
+ - Array ordenado alfabeticamente..
102
+
103
+ #### Defined in
104
+
105
+ src/utils/ArrayUtils.ts:88
106
+
107
+ ___
108
+
109
+ ### isIn
110
+
111
+ ▸ `Static` **isIn**(`arr`, `obj`): `boolean`
112
+
113
+ Remove um objeto do array.
114
+
115
+ #### Parameters
116
+
117
+ | Name | Type | Description |
118
+ | :------ | :------ | :------ |
119
+ | `arr` | `any` | - |
120
+ | `obj` | `any` | Objeto a ser removido. |
121
+
122
+ #### Returns
123
+
124
+ `boolean`
125
+
126
+ - Array sem o Objeto informado.
127
+
128
+ #### Defined in
129
+
130
+ src/utils/ArrayUtils.ts:131
51
131
 
52
132
  ___
53
133
 
@@ -71,7 +151,57 @@ Converte texto para caixa alta e substitui caracteres acentuados.
71
151
 
72
152
  #### Defined in
73
153
 
74
- src/utils/ArrayUtils.ts:35
154
+ src/utils/ArrayUtils.ts:36
155
+
156
+ ___
157
+
158
+ ### removeAtIndex
159
+
160
+ ▸ `Static` **removeAtIndex**(`array`, `index`): `any`
161
+
162
+ Remove um item de array de acordo com o index.
163
+
164
+ #### Parameters
165
+
166
+ | Name | Type | Description |
167
+ | :------ | :------ | :------ |
168
+ | `array` | `any` | Array onde está o item. |
169
+ | `index` | `number` | Index do item a ser removido. |
170
+
171
+ #### Returns
172
+
173
+ `any`
174
+
175
+ - Array sem o item do index informado.
176
+
177
+ #### Defined in
178
+
179
+ src/utils/ArrayUtils.ts:106
180
+
181
+ ___
182
+
183
+ ### removeReference
184
+
185
+ ▸ `Static` **removeReference**(`array`, `obj`): `any`
186
+
187
+ Remove um objeto do array.
188
+
189
+ #### Parameters
190
+
191
+ | Name | Type | Description |
192
+ | :------ | :------ | :------ |
193
+ | `array` | `any` | Array onde está o objeto. |
194
+ | `obj` | `any` | Objeto a ser removido. |
195
+
196
+ #### Returns
197
+
198
+ `any`
199
+
200
+ - Array sem o Objeto informado.
201
+
202
+ #### Defined in
203
+
204
+ src/utils/ArrayUtils.ts:119
75
205
 
76
206
  ___
77
207
 
@@ -96,4 +226,4 @@ Ordena valores de um array alfabeticamente.
96
226
 
97
227
  #### Defined in
98
228
 
99
- src/utils/ArrayUtils.ts:45
229
+ src/utils/ArrayUtils.ts:46
@@ -18,6 +18,7 @@ Classe com utiliários comuns para funções genéricas em JavaScript.
18
18
  - [isBase64](JSUtils.md#isbase64)
19
19
  - [isEllipsisActive](JSUtils.md#isellipsisactive)
20
20
  - [isHiddenElement](JSUtils.md#ishiddenelement)
21
+ - [replaceHtmlEntities](JSUtils.md#replacehtmlentities)
21
22
 
22
23
  ## Constructors
23
24
 
@@ -161,3 +162,27 @@ ___
161
162
  #### Defined in
162
163
 
163
164
  src/utils/JSUtils.ts:8
165
+
166
+ ___
167
+
168
+ ### replaceHtmlEntities
169
+
170
+ ▸ `Static` **replaceHtmlEntities**(`source`): `string`
171
+
172
+ Substitui caracteres para suas entidades HTML.
173
+
174
+ #### Parameters
175
+
176
+ | Name | Type | Description |
177
+ | :------ | :------ | :------ |
178
+ | `source` | `string` | String a ter os caracteres substituidos. |
179
+
180
+ #### Returns
181
+
182
+ `string`
183
+
184
+ - Retorna um UUID.
185
+
186
+ #### Defined in
187
+
188
+ src/utils/JSUtils.ts:105
@@ -13,6 +13,7 @@
13
13
  ### Methods
14
14
 
15
15
  - [copy](ObjectUtils.md#copy)
16
+ - [equals](ObjectUtils.md#equals)
16
17
  - [objectToString](ObjectUtils.md#objecttostring)
17
18
  - [removeEmptyValues](ObjectUtils.md#removeemptyvalues)
18
19
  - [sortByProperty](ObjectUtils.md#sortbyproperty)
@@ -56,6 +57,31 @@ src/utils/ObjectUtils.ts:13
56
57
 
57
58
  ___
58
59
 
60
+ ### equals
61
+
62
+ ▸ `Static` **equals**(`obj1`, `obj2`): `any`
63
+
64
+ Compara se um objeto é igual a outro objeto.
65
+
66
+ #### Parameters
67
+
68
+ | Name | Type | Description |
69
+ | :------ | :------ | :------ |
70
+ | `obj1` | `any` | Objeto a ser comparado. |
71
+ | `obj2` | `any` | Objeto a ser comparado. |
72
+
73
+ #### Returns
74
+
75
+ `any`
76
+
77
+ - Se o objeto 1 é igual ao objeto 2.
78
+
79
+ #### Defined in
80
+
81
+ src/utils/ObjectUtils.ts:84
82
+
83
+ ___
84
+
59
85
  ### objectToString
60
86
 
61
87
  ▸ `Static` **objectToString**(`data`): `string`
@@ -0,0 +1,43 @@
1
+ [@sankhyalabs/core](../README.md) / [Exports](../modules.md) / SearchUtils
2
+
3
+ # Class: SearchUtils
4
+
5
+ `Search`: Utilizado para manipulação de do objeto de pesquisa.
6
+
7
+ ## Table of contents
8
+
9
+ ### Constructors
10
+
11
+ - [constructor](SearchUtils.md#constructor)
12
+
13
+ ### Methods
14
+
15
+ - [buildDetails](SearchUtils.md#builddetails)
16
+
17
+ ## Constructors
18
+
19
+ ### constructor
20
+
21
+ • **new SearchUtils**()
22
+
23
+ ## Methods
24
+
25
+ ### buildDetails
26
+
27
+ ▸ `Static` **buildDetails**(`argument`, `fields`, `item`): `any`
28
+
29
+ #### Parameters
30
+
31
+ | Name | Type |
32
+ | :------ | :------ |
33
+ | `argument` | `String` |
34
+ | `fields` | `any` |
35
+ | `item` | `any` |
36
+
37
+ #### Returns
38
+
39
+ `any`
40
+
41
+ #### Defined in
42
+
43
+ src/utils/SearchUtils.ts:8
@@ -16,21 +16,27 @@
16
16
  - [decodeHtmlEntities](StringUtils.md#decodehtmlentities)
17
17
  - [formatBytes](StringUtils.md#formatbytes)
18
18
  - [generateUUID](StringUtils.md#generateuuid)
19
+ - [getArgumentNumber](StringUtils.md#getargumentnumber)
19
20
  - [getBooleanValue](StringUtils.md#getbooleanvalue)
20
21
  - [getOppositeCase](StringUtils.md#getoppositecase)
22
+ - [getSpecialCharacters](StringUtils.md#getspecialcharacters)
21
23
  - [hashCode](StringUtils.md#hashcode)
24
+ - [highlightValue](StringUtils.md#highlightvalue)
22
25
  - [isCaseable](StringUtils.md#iscaseable)
23
26
  - [isEmpty](StringUtils.md#isempty)
24
27
  - [isLowerCase](StringUtils.md#islowercase)
25
- - [isString](StringUtils.md#isstring)
26
28
  - [padEnd](StringUtils.md#padend)
27
29
  - [padStart](StringUtils.md#padstart)
28
30
  - [prettyPrecision](StringUtils.md#prettyprecision)
31
+ - [removeSpecialCharacters](StringUtils.md#removespecialcharacters)
29
32
  - [replaceAccentuatedChars](StringUtils.md#replaceaccentuatedchars)
33
+ - [replaceAccentuatedCharsHtmlEntities](StringUtils.md#replaceaccentuatedcharshtmlentities)
30
34
  - [replaceAccentuatedCharsKeepSymbols](StringUtils.md#replaceaccentuatedcharskeepsymbols)
31
35
  - [replaceAccentuatedCharsLower](StringUtils.md#replaceaccentuatedcharslower)
32
36
  - [replaceAccentuatedCharsUpper](StringUtils.md#replaceaccentuatedcharsupper)
37
+ - [replaceAll](StringUtils.md#replaceall)
33
38
  - [replaceBlankCharacters](StringUtils.md#replaceblankcharacters)
39
+ - [replaceToSpace](StringUtils.md#replacetospace)
34
40
  - [toCamelCase](StringUtils.md#tocamelcase)
35
41
  - [toKebabCase](StringUtils.md#tokebabcase)
36
42
  - [toPascalCase](StringUtils.md#topascalcase)
@@ -65,7 +71,7 @@ Determina a ordem de strings.
65
71
 
66
72
  #### Defined in
67
73
 
68
- src/utils/StringUtils.ts:248
74
+ src/utils/StringUtils.ts:236
69
75
 
70
76
  ___
71
77
 
@@ -93,7 +99,7 @@ entrada: "&lt;Teste&gt;" // retorno: "<Teste>"
93
99
 
94
100
  #### Defined in
95
101
 
96
- src/utils/StringUtils.ts:69
102
+ src/utils/StringUtils.ts:62
97
103
 
98
104
  ___
99
105
 
@@ -118,7 +124,7 @@ string formatada de acordo com a unidade.
118
124
 
119
125
  #### Defined in
120
126
 
121
- src/utils/StringUtils.ts:333
127
+ src/utils/StringUtils.ts:321
122
128
 
123
129
  ___
124
130
 
@@ -136,7 +142,27 @@ id único randômico.
136
142
 
137
143
  #### Defined in
138
144
 
139
- src/utils/StringUtils.ts:379
145
+ src/utils/StringUtils.ts:367
146
+
147
+ ___
148
+
149
+ ### getArgumentNumber
150
+
151
+ ▸ `Static` **getArgumentNumber**(`argument`): `number`
152
+
153
+ #### Parameters
154
+
155
+ | Name | Type |
156
+ | :------ | :------ |
157
+ | `argument` | `String` |
158
+
159
+ #### Returns
160
+
161
+ `number`
162
+
163
+ #### Defined in
164
+
165
+ src/utils/StringUtils.ts:471
140
166
 
141
167
  ___
142
168
 
@@ -168,7 +194,7 @@ Informado: 'false' | Retorna: false
168
194
 
169
195
  #### Defined in
170
196
 
171
- src/utils/StringUtils.ts:178
197
+ src/utils/StringUtils.ts:166
172
198
 
173
199
  ___
174
200
 
@@ -192,7 +218,27 @@ A string invertida
192
218
 
193
219
  #### Defined in
194
220
 
195
- src/utils/StringUtils.ts:414
221
+ src/utils/StringUtils.ts:402
222
+
223
+ ___
224
+
225
+ ### getSpecialCharacters
226
+
227
+ ▸ `Static` **getSpecialCharacters**(`str`): `string`[]
228
+
229
+ #### Parameters
230
+
231
+ | Name | Type |
232
+ | :------ | :------ |
233
+ | `str` | `string` |
234
+
235
+ #### Returns
236
+
237
+ `string`[]
238
+
239
+ #### Defined in
240
+
241
+ src/utils/StringUtils.ts:443
196
242
 
197
243
  ___
198
244
 
@@ -222,7 +268,31 @@ Informado: '123456' | Retorna: 1450575459
222
268
 
223
269
  #### Defined in
224
270
 
225
- src/utils/StringUtils.ts:156
271
+ src/utils/StringUtils.ts:145
272
+
273
+ ___
274
+
275
+ ### highlightValue
276
+
277
+ ▸ `Static` **highlightValue**(`argument`, `matchFields`, `value`, `fieldMD`, `forceMatch`): `string`
278
+
279
+ #### Parameters
280
+
281
+ | Name | Type |
282
+ | :------ | :------ |
283
+ | `argument` | `String` |
284
+ | `matchFields` | `any` |
285
+ | `value` | `string` |
286
+ | `fieldMD` | `any` |
287
+ | `forceMatch` | `boolean` |
288
+
289
+ #### Returns
290
+
291
+ `string`
292
+
293
+ #### Defined in
294
+
295
+ src/utils/StringUtils.ts:475
226
296
 
227
297
  ___
228
298
 
@@ -246,7 +316,7 @@ Se a string pode ser convertida
246
316
 
247
317
  #### Defined in
248
318
 
249
- src/utils/StringUtils.ts:389
319
+ src/utils/StringUtils.ts:377
250
320
 
251
321
  ___
252
322
 
@@ -271,7 +341,7 @@ Valores null e undefined são considerados como vazio.
271
341
 
272
342
  #### Defined in
273
343
 
274
- src/utils/StringUtils.ts:16
344
+ src/utils/StringUtils.ts:18
275
345
 
276
346
  ___
277
347
 
@@ -295,29 +365,7 @@ Se a string é minúscula
295
365
 
296
366
  #### Defined in
297
367
 
298
- src/utils/StringUtils.ts:402
299
-
300
- ___
301
-
302
- ### isString
303
-
304
- ▸ `Static` **isString**(`text`): `boolean`
305
-
306
- Verifica se argumento informado é do tipo string
307
-
308
- #### Parameters
309
-
310
- | Name | Type |
311
- | :------ | :------ |
312
- | `text` | `any` |
313
-
314
- #### Returns
315
-
316
- `boolean`
317
-
318
- #### Defined in
319
-
320
- src/utils/StringUtils.ts:36
368
+ src/utils/StringUtils.ts:390
321
369
 
322
370
  ___
323
371
 
@@ -356,7 +404,7 @@ Ou retorna o texto com os caracteres adicionados na direita.
356
404
 
357
405
  #### Defined in
358
406
 
359
- src/utils/StringUtils.ts:232
407
+ src/utils/StringUtils.ts:220
360
408
 
361
409
  ___
362
410
 
@@ -395,7 +443,7 @@ Ou retorna o texto com os caracteres adicionados na esquerda.
395
443
 
396
444
  #### Defined in
397
445
 
398
- src/utils/StringUtils.ts:207
446
+ src/utils/StringUtils.ts:195
399
447
 
400
448
  ___
401
449
 
@@ -420,7 +468,27 @@ simplificação do strNumber, sem os zeros à direita depois do ponto.
420
468
 
421
469
  #### Defined in
422
470
 
423
- src/utils/StringUtils.ts:358
471
+ src/utils/StringUtils.ts:346
472
+
473
+ ___
474
+
475
+ ### removeSpecialCharacters
476
+
477
+ ▸ `Static` **removeSpecialCharacters**(`str`): `string`
478
+
479
+ #### Parameters
480
+
481
+ | Name | Type |
482
+ | :------ | :------ |
483
+ | `str` | `string` |
484
+
485
+ #### Returns
486
+
487
+ `string`
488
+
489
+ #### Defined in
490
+
491
+ src/utils/StringUtils.ts:462
424
492
 
425
493
  ___
426
494
 
@@ -450,7 +518,27 @@ entrada: "á@Êç#Ò", true // retorno: "aEcO"
450
518
 
451
519
  #### Defined in
452
520
 
453
- src/utils/StringUtils.ts:122
521
+ src/utils/StringUtils.ts:115
522
+
523
+ ___
524
+
525
+ ### replaceAccentuatedCharsHtmlEntities
526
+
527
+ ▸ `Static` **replaceAccentuatedCharsHtmlEntities**(`source`): `string`
528
+
529
+ #### Parameters
530
+
531
+ | Name | Type |
532
+ | :------ | :------ |
533
+ | `source` | `string` |
534
+
535
+ #### Returns
536
+
537
+ `string`
538
+
539
+ #### Defined in
540
+
541
+ src/utils/StringUtils.ts:423
454
542
 
455
543
  ___
456
544
 
@@ -474,7 +562,7 @@ Remove acentos de vogais, substitui Ç por c e retorna a string em caixa alta ma
474
562
 
475
563
  #### Defined in
476
564
 
477
- src/utils/StringUtils.ts:141
565
+ src/utils/StringUtils.ts:134
478
566
 
479
567
  ___
480
568
 
@@ -502,7 +590,7 @@ entrada: "áêçò" // retorno: "aeco"
502
590
 
503
591
  #### Defined in
504
592
 
505
- src/utils/StringUtils.ts:99
593
+ src/utils/StringUtils.ts:92
506
594
 
507
595
  ___
508
596
 
@@ -530,7 +618,29 @@ entrada: "ÁÊÇÒ" // retorno: "AECO"
530
618
 
531
619
  #### Defined in
532
620
 
533
- src/utils/StringUtils.ts:47
621
+ src/utils/StringUtils.ts:40
622
+
623
+ ___
624
+
625
+ ### replaceAll
626
+
627
+ ▸ `Static` **replaceAll**(`str`, `strFrom`, `strTo`): `string`
628
+
629
+ #### Parameters
630
+
631
+ | Name | Type |
632
+ | :------ | :------ |
633
+ | `str` | `string` |
634
+ | `strFrom` | `string` |
635
+ | `strTo` | `string` |
636
+
637
+ #### Returns
638
+
639
+ `string`
640
+
641
+ #### Defined in
642
+
643
+ src/utils/StringUtils.ts:453
534
644
 
535
645
  ___
536
646
 
@@ -554,7 +664,28 @@ String sem espaços em branco.
554
664
 
555
665
  #### Defined in
556
666
 
557
- src/utils/StringUtils.ts:323
667
+ src/utils/StringUtils.ts:311
668
+
669
+ ___
670
+
671
+ ### replaceToSpace
672
+
673
+ ▸ `Static` **replaceToSpace**(`source`, `replaceList?`): `string`
674
+
675
+ #### Parameters
676
+
677
+ | Name | Type | Default value |
678
+ | :------ | :------ | :------ |
679
+ | `source` | `string` | `undefined` |
680
+ | `replaceList` | `string`[] | `[]` |
681
+
682
+ #### Returns
683
+
684
+ `string`
685
+
686
+ #### Defined in
687
+
688
+ src/utils/StringUtils.ts:406
558
689
 
559
690
  ___
560
691
 
@@ -585,7 +716,7 @@ String convertida em camelCase.
585
716
 
586
717
  #### Defined in
587
718
 
588
- src/utils/StringUtils.ts:274
719
+ src/utils/StringUtils.ts:262
589
720
 
590
721
  ___
591
722
 
@@ -609,7 +740,7 @@ String convertida em KebabCase.
609
740
 
610
741
  #### Defined in
611
742
 
612
- src/utils/StringUtils.ts:314
743
+ src/utils/StringUtils.ts:302
613
744
 
614
745
  ___
615
746
 
@@ -633,7 +764,7 @@ String convertida em PascalCase.
633
764
 
634
765
  #### Defined in
635
766
 
636
- src/utils/StringUtils.ts:289
767
+ src/utils/StringUtils.ts:277
637
768
 
638
769
  ___
639
770
 
@@ -657,4 +788,4 @@ String convertida em snake_case.
657
788
 
658
789
  #### Defined in
659
790
 
660
- src/utils/StringUtils.ts:301
791
+ src/utils/StringUtils.ts:289
package/modules.md CHANGED
@@ -45,6 +45,7 @@
45
45
  - [PromiseSync](classes/PromiseSync.md)
46
46
  - [ReadyUtil](classes/ReadyUtil.md)
47
47
  - [RequestMetadata](classes/RequestMetadata.md)
48
+ - [SearchUtils](classes/SearchUtils.md)
48
49
  - [SelectionInfo](classes/SelectionInfo.md)
49
50
  - [SkwHttpProvider](classes/SkwHttpProvider.md)
50
51
  - [StringUtils](classes/StringUtils.md)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/core-docs",
3
- "version": "0.0.0-feat-dev-KB-25740.0",
3
+ "version": "0.0.0-feat-dev-KB-28409.1",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [