@sankhyalabs/core-docs 5.15.0 → 5.20.0-dev.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,9 +16,12 @@
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)
@@ -26,11 +29,15 @@
26
29
  - [padEnd](StringUtils.md#padend)
27
30
  - [padStart](StringUtils.md#padstart)
28
31
  - [prettyPrecision](StringUtils.md#prettyprecision)
32
+ - [removeSpecialCharacters](StringUtils.md#removespecialcharacters)
29
33
  - [replaceAccentuatedChars](StringUtils.md#replaceaccentuatedchars)
34
+ - [replaceAccentuatedCharsHtmlEntities](StringUtils.md#replaceaccentuatedcharshtmlentities)
30
35
  - [replaceAccentuatedCharsKeepSymbols](StringUtils.md#replaceaccentuatedcharskeepsymbols)
31
36
  - [replaceAccentuatedCharsLower](StringUtils.md#replaceaccentuatedcharslower)
32
37
  - [replaceAccentuatedCharsUpper](StringUtils.md#replaceaccentuatedcharsupper)
38
+ - [replaceAll](StringUtils.md#replaceall)
33
39
  - [replaceBlankCharacters](StringUtils.md#replaceblankcharacters)
40
+ - [replaceToSpace](StringUtils.md#replacetospace)
34
41
  - [toCamelCase](StringUtils.md#tocamelcase)
35
42
  - [toKebabCase](StringUtils.md#tokebabcase)
36
43
  - [toPascalCase](StringUtils.md#topascalcase)
@@ -65,7 +72,7 @@ Determina a ordem de strings.
65
72
 
66
73
  #### Defined in
67
74
 
68
- src/utils/StringUtils.ts:248
75
+ src/utils/StringUtils.ts:250
69
76
 
70
77
  ___
71
78
 
@@ -93,7 +100,7 @@ entrada: "&lt;Teste&gt;" // retorno: "<Teste>"
93
100
 
94
101
  #### Defined in
95
102
 
96
- src/utils/StringUtils.ts:69
103
+ src/utils/StringUtils.ts:71
97
104
 
98
105
  ___
99
106
 
@@ -118,7 +125,7 @@ string formatada de acordo com a unidade.
118
125
 
119
126
  #### Defined in
120
127
 
121
- src/utils/StringUtils.ts:333
128
+ src/utils/StringUtils.ts:335
122
129
 
123
130
  ___
124
131
 
@@ -136,7 +143,27 @@ id único randômico.
136
143
 
137
144
  #### Defined in
138
145
 
139
- src/utils/StringUtils.ts:379
146
+ src/utils/StringUtils.ts:381
147
+
148
+ ___
149
+
150
+ ### getArgumentNumber
151
+
152
+ ▸ `Static` **getArgumentNumber**(`argument`): `number`
153
+
154
+ #### Parameters
155
+
156
+ | Name | Type |
157
+ | :------ | :------ |
158
+ | `argument` | `String` |
159
+
160
+ #### Returns
161
+
162
+ `number`
163
+
164
+ #### Defined in
165
+
166
+ src/utils/StringUtils.ts:485
140
167
 
141
168
  ___
142
169
 
@@ -168,7 +195,7 @@ Informado: 'false' | Retorna: false
168
195
 
169
196
  #### Defined in
170
197
 
171
- src/utils/StringUtils.ts:178
198
+ src/utils/StringUtils.ts:180
172
199
 
173
200
  ___
174
201
 
@@ -192,7 +219,27 @@ A string invertida
192
219
 
193
220
  #### Defined in
194
221
 
195
- src/utils/StringUtils.ts:414
222
+ src/utils/StringUtils.ts:416
223
+
224
+ ___
225
+
226
+ ### getSpecialCharacters
227
+
228
+ ▸ `Static` **getSpecialCharacters**(`str`): `string`[]
229
+
230
+ #### Parameters
231
+
232
+ | Name | Type |
233
+ | :------ | :------ |
234
+ | `str` | `string` |
235
+
236
+ #### Returns
237
+
238
+ `string`[]
239
+
240
+ #### Defined in
241
+
242
+ src/utils/StringUtils.ts:457
196
243
 
197
244
  ___
198
245
 
@@ -222,7 +269,31 @@ Informado: '123456' | Retorna: 1450575459
222
269
 
223
270
  #### Defined in
224
271
 
225
- src/utils/StringUtils.ts:156
272
+ src/utils/StringUtils.ts:158
273
+
274
+ ___
275
+
276
+ ### highlightValue
277
+
278
+ ▸ `Static` **highlightValue**(`argument`, `matchFields`, `value`, `fieldMD`, `forceMatch`): `string`
279
+
280
+ #### Parameters
281
+
282
+ | Name | Type |
283
+ | :------ | :------ |
284
+ | `argument` | `String` |
285
+ | `matchFields` | `any` |
286
+ | `value` | `string` |
287
+ | `fieldMD` | `any` |
288
+ | `forceMatch` | `boolean` |
289
+
290
+ #### Returns
291
+
292
+ `string`
293
+
294
+ #### Defined in
295
+
296
+ src/utils/StringUtils.ts:489
226
297
 
227
298
  ___
228
299
 
@@ -246,7 +317,7 @@ Se a string pode ser convertida
246
317
 
247
318
  #### Defined in
248
319
 
249
- src/utils/StringUtils.ts:389
320
+ src/utils/StringUtils.ts:391
250
321
 
251
322
  ___
252
323
 
@@ -271,7 +342,7 @@ Valores null e undefined são considerados como vazio.
271
342
 
272
343
  #### Defined in
273
344
 
274
- src/utils/StringUtils.ts:16
345
+ src/utils/StringUtils.ts:18
275
346
 
276
347
  ___
277
348
 
@@ -295,7 +366,7 @@ Se a string é minúscula
295
366
 
296
367
  #### Defined in
297
368
 
298
- src/utils/StringUtils.ts:402
369
+ src/utils/StringUtils.ts:404
299
370
 
300
371
  ___
301
372
 
@@ -317,7 +388,7 @@ Verifica se argumento informado é do tipo string
317
388
 
318
389
  #### Defined in
319
390
 
320
- src/utils/StringUtils.ts:36
391
+ src/utils/StringUtils.ts:38
321
392
 
322
393
  ___
323
394
 
@@ -356,7 +427,7 @@ Ou retorna o texto com os caracteres adicionados na direita.
356
427
 
357
428
  #### Defined in
358
429
 
359
- src/utils/StringUtils.ts:232
430
+ src/utils/StringUtils.ts:234
360
431
 
361
432
  ___
362
433
 
@@ -395,7 +466,7 @@ Ou retorna o texto com os caracteres adicionados na esquerda.
395
466
 
396
467
  #### Defined in
397
468
 
398
- src/utils/StringUtils.ts:207
469
+ src/utils/StringUtils.ts:209
399
470
 
400
471
  ___
401
472
 
@@ -420,7 +491,27 @@ simplificação do strNumber, sem os zeros à direita depois do ponto.
420
491
 
421
492
  #### Defined in
422
493
 
423
- src/utils/StringUtils.ts:358
494
+ src/utils/StringUtils.ts:360
495
+
496
+ ___
497
+
498
+ ### removeSpecialCharacters
499
+
500
+ ▸ `Static` **removeSpecialCharacters**(`str`): `string`
501
+
502
+ #### Parameters
503
+
504
+ | Name | Type |
505
+ | :------ | :------ |
506
+ | `str` | `string` |
507
+
508
+ #### Returns
509
+
510
+ `string`
511
+
512
+ #### Defined in
513
+
514
+ src/utils/StringUtils.ts:476
424
515
 
425
516
  ___
426
517
 
@@ -450,7 +541,27 @@ entrada: "á@Êç#Ò", true // retorno: "aEcO"
450
541
 
451
542
  #### Defined in
452
543
 
453
- src/utils/StringUtils.ts:122
544
+ src/utils/StringUtils.ts:124
545
+
546
+ ___
547
+
548
+ ### replaceAccentuatedCharsHtmlEntities
549
+
550
+ ▸ `Static` **replaceAccentuatedCharsHtmlEntities**(`source`): `string`
551
+
552
+ #### Parameters
553
+
554
+ | Name | Type |
555
+ | :------ | :------ |
556
+ | `source` | `string` |
557
+
558
+ #### Returns
559
+
560
+ `string`
561
+
562
+ #### Defined in
563
+
564
+ src/utils/StringUtils.ts:437
454
565
 
455
566
  ___
456
567
 
@@ -474,7 +585,7 @@ Remove acentos de vogais, substitui Ç por c e retorna a string em caixa alta ma
474
585
 
475
586
  #### Defined in
476
587
 
477
- src/utils/StringUtils.ts:141
588
+ src/utils/StringUtils.ts:143
478
589
 
479
590
  ___
480
591
 
@@ -502,7 +613,7 @@ entrada: "áêçò" // retorno: "aeco"
502
613
 
503
614
  #### Defined in
504
615
 
505
- src/utils/StringUtils.ts:99
616
+ src/utils/StringUtils.ts:101
506
617
 
507
618
  ___
508
619
 
@@ -530,7 +641,29 @@ entrada: "ÁÊÇÒ" // retorno: "AECO"
530
641
 
531
642
  #### Defined in
532
643
 
533
- src/utils/StringUtils.ts:47
644
+ src/utils/StringUtils.ts:49
645
+
646
+ ___
647
+
648
+ ### replaceAll
649
+
650
+ ▸ `Static` **replaceAll**(`str`, `strFrom`, `strTo`): `string`
651
+
652
+ #### Parameters
653
+
654
+ | Name | Type |
655
+ | :------ | :------ |
656
+ | `str` | `string` |
657
+ | `strFrom` | `string` |
658
+ | `strTo` | `string` |
659
+
660
+ #### Returns
661
+
662
+ `string`
663
+
664
+ #### Defined in
665
+
666
+ src/utils/StringUtils.ts:467
534
667
 
535
668
  ___
536
669
 
@@ -554,7 +687,28 @@ String sem espaços em branco.
554
687
 
555
688
  #### Defined in
556
689
 
557
- src/utils/StringUtils.ts:323
690
+ src/utils/StringUtils.ts:325
691
+
692
+ ___
693
+
694
+ ### replaceToSpace
695
+
696
+ ▸ `Static` **replaceToSpace**(`source`, `replaceList?`): `string`
697
+
698
+ #### Parameters
699
+
700
+ | Name | Type | Default value |
701
+ | :------ | :------ | :------ |
702
+ | `source` | `string` | `undefined` |
703
+ | `replaceList` | `string`[] | `[]` |
704
+
705
+ #### Returns
706
+
707
+ `string`
708
+
709
+ #### Defined in
710
+
711
+ src/utils/StringUtils.ts:420
558
712
 
559
713
  ___
560
714
 
@@ -585,7 +739,7 @@ String convertida em camelCase.
585
739
 
586
740
  #### Defined in
587
741
 
588
- src/utils/StringUtils.ts:274
742
+ src/utils/StringUtils.ts:276
589
743
 
590
744
  ___
591
745
 
@@ -609,7 +763,7 @@ String convertida em KebabCase.
609
763
 
610
764
  #### Defined in
611
765
 
612
- src/utils/StringUtils.ts:314
766
+ src/utils/StringUtils.ts:316
613
767
 
614
768
  ___
615
769
 
@@ -633,7 +787,7 @@ String convertida em PascalCase.
633
787
 
634
788
  #### Defined in
635
789
 
636
- src/utils/StringUtils.ts:289
790
+ src/utils/StringUtils.ts:291
637
791
 
638
792
  ___
639
793
 
@@ -657,4 +811,4 @@ String convertida em snake_case.
657
811
 
658
812
  #### Defined in
659
813
 
660
- src/utils/StringUtils.ts:301
814
+ src/utils/StringUtils.ts:303
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": "5.15.0",
3
+ "version": "5.20.0-dev.1",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [