@sankhyalabs/core-docs 5.15.5 → 5.16.0

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 (81) hide show
  1. package/README.md +3 -1
  2. package/classes/ApplicationContext.md +31 -32
  3. package/classes/ArrayUtils.md +183 -41
  4. package/classes/AuthorizedServiceCaller.md +25 -34
  5. package/classes/Change.md +59 -74
  6. package/classes/DataUnit.md +970 -1068
  7. package/classes/DataUnitAction.md +25 -42
  8. package/classes/DataUnitStorage.md +40 -43
  9. package/classes/DateUtils.md +133 -126
  10. package/classes/ElementIDUtils.md +123 -122
  11. package/classes/ErrorException.md +67 -88
  12. package/classes/ErrorTracking.md +20 -23
  13. package/classes/FieldComparator.md +35 -39
  14. package/classes/FloatingManager.md +195 -198
  15. package/classes/HTMLBuilder.md +14 -20
  16. package/classes/HttpProvider.md +45 -41
  17. package/classes/IDBRepository.md +179 -196
  18. package/classes/JSUtils.md +82 -58
  19. package/classes/KeyboardManager.md +95 -87
  20. package/classes/{MaskFormatter-1.md → MaskFormatter.md} +81 -120
  21. package/classes/NumberUtils.md +163 -152
  22. package/classes/ObjectUtils.md +82 -61
  23. package/classes/OnboardingUtils.md +36 -51
  24. package/classes/OverflowWatcher.md +269 -0
  25. package/classes/PromiseSync.md +25 -42
  26. package/classes/ReadyUtil.md +31 -41
  27. package/classes/RequestMetadata.md +29 -30
  28. package/classes/SearchUtils.md +41 -0
  29. package/classes/SelectionInfo.md +59 -74
  30. package/classes/SkwHttpProvider.md +33 -45
  31. package/classes/StringUtils.md +397 -268
  32. package/classes/TimeFormatter.md +43 -44
  33. package/classes/UserAgentUtils.md +17 -20
  34. package/classes/VersionUtils.md +15 -18
  35. package/classes/WaitingChangeException.md +63 -84
  36. package/classes/WarningException.md +67 -88
  37. package/enumerations/Action.md +297 -0
  38. package/enumerations/ChangeOperation.md +47 -0
  39. package/enumerations/DataType.md +57 -0
  40. package/enumerations/DependencyType.md +37 -0
  41. package/enumerations/OverflowDirection.md +29 -0
  42. package/enumerations/SelectionMode.md +27 -0
  43. package/enumerations/SortMode.md +27 -0
  44. package/enumerations/UserInterface.md +177 -0
  45. package/functions/defaultDataLoader.md +25 -0
  46. package/{modules.md → globals.md} +22 -37
  47. package/interfaces/ChildDescriptor.md +12 -16
  48. package/interfaces/ChildLink.md +9 -12
  49. package/interfaces/DUActionInterceptor.md +10 -14
  50. package/interfaces/ExecutionContext.md +17 -32
  51. package/interfaces/FieldDescriptor.md +52 -66
  52. package/interfaces/Filter.md +13 -17
  53. package/interfaces/IElementIDInfo.md +11 -14
  54. package/interfaces/ILoadResult.md +11 -16
  55. package/interfaces/IRepository.md +88 -93
  56. package/interfaces/IRepositoryIndex.md +23 -30
  57. package/interfaces/LoadDataRequest.md +36 -45
  58. package/interfaces/LoadDataResponse.md +11 -14
  59. package/interfaces/PageRequest.md +16 -20
  60. package/interfaces/PaginationInfo.md +24 -31
  61. package/interfaces/PromiseSyncCallback.md +13 -17
  62. package/interfaces/QuickFilter.md +17 -21
  63. package/interfaces/Record.md +26 -33
  64. package/interfaces/SavedRecord.md +33 -41
  65. package/interfaces/Sort.md +12 -16
  66. package/interfaces/SortingProvider.md +10 -13
  67. package/interfaces/UnitMetadata.md +16 -21
  68. package/interfaces/WaitingChange.md +16 -20
  69. package/namespaces/MaskFormatter/README.md +17 -0
  70. package/namespaces/MaskFormatter/type-aliases/MaskCharacter.md +13 -0
  71. package/namespaces/MaskFormatter/variables/MaskCharacter.md +13 -0
  72. package/package.json +1 -1
  73. package/type-aliases/OnOverflowCallBack.md +25 -0
  74. package/enums/Action.md +0 -327
  75. package/enums/ChangeOperation.md +0 -52
  76. package/enums/DataType.md +0 -63
  77. package/enums/DependencyType.md +0 -41
  78. package/enums/SelectionMode.md +0 -30
  79. package/enums/SortMode.md +0 -30
  80. package/enums/UserInterface.md +0 -195
  81. package/modules/MaskFormatter.md +0 -37
@@ -1,61 +1,40 @@
1
- [@sankhyalabs/core](../README.md) / [Exports](../modules.md) / StringUtils
1
+ [**@sankhyalabs/core**](../README.md) **Docs**
2
+
3
+ ***
4
+
5
+ [@sankhyalabs/core](../globals.md) / StringUtils
2
6
 
3
7
  # Class: StringUtils
4
8
 
5
9
  `StringUtils`: Utilizado para manipulação de Strings.
6
10
 
7
- ## Table of contents
8
-
9
- ### Constructors
10
-
11
- - [constructor](StringUtils.md#constructor)
12
-
13
- ### Methods
14
-
15
- - [compare](StringUtils.md#compare)
16
- - [decodeHtmlEntities](StringUtils.md#decodehtmlentities)
17
- - [formatBytes](StringUtils.md#formatbytes)
18
- - [generateUUID](StringUtils.md#generateuuid)
19
- - [getBooleanValue](StringUtils.md#getbooleanvalue)
20
- - [getOppositeCase](StringUtils.md#getoppositecase)
21
- - [hashCode](StringUtils.md#hashcode)
22
- - [isCaseable](StringUtils.md#iscaseable)
23
- - [isEmpty](StringUtils.md#isempty)
24
- - [isLowerCase](StringUtils.md#islowercase)
25
- - [isString](StringUtils.md#isstring)
26
- - [padEnd](StringUtils.md#padend)
27
- - [padStart](StringUtils.md#padstart)
28
- - [prettyPrecision](StringUtils.md#prettyprecision)
29
- - [replaceAccentuatedChars](StringUtils.md#replaceaccentuatedchars)
30
- - [replaceAccentuatedCharsKeepSymbols](StringUtils.md#replaceaccentuatedcharskeepsymbols)
31
- - [replaceAccentuatedCharsLower](StringUtils.md#replaceaccentuatedcharslower)
32
- - [replaceAccentuatedCharsUpper](StringUtils.md#replaceaccentuatedcharsupper)
33
- - [replaceBlankCharacters](StringUtils.md#replaceblankcharacters)
34
- - [toCamelCase](StringUtils.md#tocamelcase)
35
- - [toKebabCase](StringUtils.md#tokebabcase)
36
- - [toPascalCase](StringUtils.md#topascalcase)
37
- - [toSnakeCase](StringUtils.md#tosnakecase)
38
-
39
11
  ## Constructors
40
12
 
41
- ### constructor
13
+ ### new StringUtils()
42
14
 
43
- **new StringUtils**()
15
+ > **new StringUtils**(): [`StringUtils`](StringUtils.md)
16
+
17
+ #### Returns
18
+
19
+ [`StringUtils`](StringUtils.md)
44
20
 
45
21
  ## Methods
46
22
 
47
- ### compare
23
+ ### compare()
48
24
 
49
- `Static` **compare**(`a`, `b`): `number`
25
+ > `static` **compare**(`a`, `b`): `number`
50
26
 
51
27
  Determina a ordem de strings.
52
28
 
53
29
  #### Parameters
54
30
 
55
- | Name | Type | Description |
56
- | :------ | :------ | :------ |
57
- | `a` | `string` | Primeira string para comparação. |
58
- | `b` | `string` | Segunda string para comparação. |
31
+ **a**: `string`
32
+
33
+ Primeira string para comparação.
34
+
35
+ • **b**: `string`
36
+
37
+ Segunda string para comparação.
59
38
 
60
39
  #### Returns
61
40
 
@@ -63,52 +42,50 @@ Determina a ordem de strings.
63
42
 
64
43
  - Um numeral negativo se o primeiro argumento é menor que o segundo, zero se os dois são iguais e um numeral positivo quando o primeiro é maior que o segundo.
65
44
 
66
- #### Defined in
45
+ #### Source
67
46
 
68
- src/utils/StringUtils.ts:248
47
+ src/utils/StringUtils.ts:250
69
48
 
70
- ___
49
+ ***
71
50
 
72
- ### decodeHtmlEntities
51
+ ### decodeHtmlEntities()
73
52
 
74
- `Static` **decodeHtmlEntities**(`text`): `string`
53
+ > `static` **decodeHtmlEntities**(`text`): `string`
75
54
 
76
55
  Converte todas as entidades HTML de um texto
77
56
 
78
- **`Example`**
79
-
80
- ```ts
81
- entrada: "&lt;Teste&gt;" // retorno: "<Teste>"
82
- ```
83
-
84
57
  #### Parameters
85
58
 
86
- | Name | Type | Description |
87
- | :------ | :------ | :------ |
88
- | `text` | `string` | String para ser transformada. |
59
+ **text**: `string`
60
+
61
+ String para ser transformada.
89
62
 
90
63
  #### Returns
91
64
 
92
65
  `string`
93
66
 
94
- #### Defined in
67
+ #### Example
68
+
69
+ ```ts
70
+ entrada: "&lt;Teste&gt;" // retorno: "<Teste>"
71
+ ```
72
+
73
+ #### Source
95
74
 
96
- src/utils/StringUtils.ts:69
75
+ src/utils/StringUtils.ts:71
97
76
 
98
- ___
77
+ ***
99
78
 
100
- ### formatBytes
79
+ ### formatBytes()
101
80
 
102
- `Static` **formatBytes**(`bytes`): `string`
81
+ > `static` **formatBytes**(`bytes`): `string`
103
82
 
104
83
  Utilitário para formatar bytes em string legível, convertendo para
105
84
  múltiplos maiores caso necessário.
106
85
 
107
86
  #### Parameters
108
87
 
109
- | Name | Type |
110
- | :------ | :------ |
111
- | `bytes` | `number` |
88
+ **bytes**: `number`
112
89
 
113
90
  #### Returns
114
91
 
@@ -116,15 +93,15 @@ múltiplos maiores caso necessário.
116
93
 
117
94
  string formatada de acordo com a unidade.
118
95
 
119
- #### Defined in
96
+ #### Source
120
97
 
121
- src/utils/StringUtils.ts:333
98
+ src/utils/StringUtils.ts:335
122
99
 
123
- ___
100
+ ***
124
101
 
125
- ### generateUUID
102
+ ### generateUUID()
126
103
 
127
- `Static` **generateUUID**(): `string`
104
+ > `static` **generateUUID**(): `string`
128
105
 
129
106
  Método utilizado para gerar IDs únicos.
130
107
 
@@ -134,31 +111,45 @@ Método utilizado para gerar IDs únicos.
134
111
 
135
112
  id único randômico.
136
113
 
137
- #### Defined in
114
+ #### Source
138
115
 
139
- src/utils/StringUtils.ts:379
116
+ src/utils/StringUtils.ts:381
140
117
 
141
- ___
118
+ ***
142
119
 
143
- ### getBooleanValue
120
+ ### getArgumentNumber()
144
121
 
145
- `Static` **getBooleanValue**(`value`, `defaultValue?`): `boolean`
122
+ > `static` **getArgumentNumber**(`argument`): `number`
146
123
 
147
- Converte um texto do tipo string para um booleano.
124
+ #### Parameters
148
125
 
149
- **`Example`**
126
+ • **argument**: `String`
150
127
 
151
- ```ts
152
- Informado: 'true' | Retorna: true
153
- Informado: 'false' | Retorna: false
154
- ```
128
+ #### Returns
129
+
130
+ `number`
131
+
132
+ #### Source
133
+
134
+ src/utils/StringUtils.ts:485
135
+
136
+ ***
137
+
138
+ ### getBooleanValue()
139
+
140
+ > `static` **getBooleanValue**(`value`, `defaultValue`): `boolean`
141
+
142
+ Converte um texto do tipo string para um booleano.
155
143
 
156
144
  #### Parameters
157
145
 
158
- | Name | Type | Default value | Description |
159
- | :------ | :------ | :------ | :------ |
160
- | `value` | `string` | `undefined` | Valor a ser convertido. |
161
- | `defaultValue` | `boolean` | `false` | Valor padrão. |
146
+ **value**: `string`
147
+
148
+ Valor a ser convertido.
149
+
150
+ • **defaultValue**: `boolean`= `false`
151
+
152
+ Valor padrão.
162
153
 
163
154
  #### Returns
164
155
 
@@ -166,23 +157,30 @@ Informado: 'false' | Retorna: false
166
157
 
167
158
  - Texto convertido.
168
159
 
169
- #### Defined in
160
+ #### Example
161
+
162
+ ```ts
163
+ Informado: 'true' | Retorna: true
164
+ Informado: 'false' | Retorna: false
165
+ ```
166
+
167
+ #### Source
170
168
 
171
- src/utils/StringUtils.ts:178
169
+ src/utils/StringUtils.ts:180
172
170
 
173
- ___
171
+ ***
174
172
 
175
- ### getOppositeCase
173
+ ### getOppositeCase()
176
174
 
177
- `Static` **getOppositeCase**(`original`): `string`
175
+ > `static` **getOppositeCase**(`original`): `string`
178
176
 
179
177
  Inverte uma string de minúsculas para maiúsculas e vice-versa
180
178
 
181
179
  #### Parameters
182
180
 
183
- | Name | Type | Description |
184
- | :------ | :------ | :------ |
185
- | `original` | `string` | A string a ser invertida |
181
+ **original**: `string`
182
+
183
+ A string a ser invertida
186
184
 
187
185
  #### Returns
188
186
 
@@ -190,53 +188,97 @@ Inverte uma string de minúsculas para maiúsculas e vice-versa
190
188
 
191
189
  A string invertida
192
190
 
193
- #### Defined in
191
+ #### Source
192
+
193
+ src/utils/StringUtils.ts:416
194
194
 
195
- src/utils/StringUtils.ts:414
195
+ ***
196
196
 
197
- ___
197
+ ### getSpecialCharacters()
198
198
 
199
- ### hashCode
199
+ > `static` **getSpecialCharacters**(`str`): `string`[]
200
200
 
201
- `Static` **hashCode**(`value`): `string`
201
+ #### Parameters
202
+
203
+ • **str**: `string`
204
+
205
+ #### Returns
206
+
207
+ `string`[]
208
+
209
+ #### Source
210
+
211
+ src/utils/StringUtils.ts:457
212
+
213
+ ***
214
+
215
+ ### hashCode()
216
+
217
+ > `static` **hashCode**(`value`): `string`
202
218
 
203
219
  Calcula um código hash para uma string.
204
220
 
205
- **`Example`**
221
+ #### Parameters
222
+
223
+ • **value**: `string`
224
+
225
+ String que será gerado o hash code.
226
+
227
+ #### Returns
228
+
229
+ `string`
230
+
231
+ - Um hash calculado com base no valor informado.
232
+
233
+ #### Example
206
234
 
207
235
  ```ts
208
236
  Informado: '123456' | Retorna: 1450575459
209
237
  ```
210
238
 
239
+ #### Source
240
+
241
+ src/utils/StringUtils.ts:158
242
+
243
+ ***
244
+
245
+ ### highlightValue()
246
+
247
+ > `static` **highlightValue**(`argument`, `matchFields`, `value`, `fieldMD`, `forceMatch`): `string`
248
+
211
249
  #### Parameters
212
250
 
213
- | Name | Type | Description |
214
- | :------ | :------ | :------ |
215
- | `value` | `string` | String que será gerado o hash code. |
251
+ **argument**: `String`
252
+
253
+ **matchFields**: `any`
254
+
255
+ • **value**: `string`
256
+
257
+ • **fieldMD**: `any`
258
+
259
+ • **forceMatch**: `boolean`
216
260
 
217
261
  #### Returns
218
262
 
219
263
  `string`
220
264
 
221
- - Um hash calculado com base no valor informado.
222
-
223
- #### Defined in
265
+ #### Source
224
266
 
225
- src/utils/StringUtils.ts:156
267
+ src/utils/StringUtils.ts:489
226
268
 
227
- ___
269
+ ***
228
270
 
229
- ### isCaseable
271
+ ### isCaseable()
230
272
 
231
- `Static` **isCaseable**(`original`): `boolean`
273
+ > `static` **isCaseable**(`original`): `boolean`
232
274
 
233
275
  Checa se uma string pode ser convertida para letras maiúsculas ou minúsculas
234
276
 
235
277
  #### Parameters
236
278
 
237
- | Name | Type | Description |
238
- | :------ | :------ | :------ |
239
- | `original` | `string` | A string a ser verificada |
279
+ **original**: `string`
280
+
281
+ A string a ser verificada
240
282
 
241
283
  #### Returns
242
284
 
@@ -244,24 +286,24 @@ Checa se uma string pode ser convertida para letras maiúsculas ou minúsculas
244
286
 
245
287
  Se a string pode ser convertida
246
288
 
247
- #### Defined in
289
+ #### Source
248
290
 
249
- src/utils/StringUtils.ts:389
291
+ src/utils/StringUtils.ts:391
250
292
 
251
- ___
293
+ ***
252
294
 
253
- ### isEmpty
295
+ ### isEmpty()
254
296
 
255
- `Static` **isEmpty**(`value`): `Boolean`
297
+ > `static` **isEmpty**(`value`): `Boolean`
256
298
 
257
299
  Retorna se a string está vazia.
258
300
  Valores null e undefined são considerados como vazio.
259
301
 
260
302
  #### Parameters
261
303
 
262
- | Name | Type | Description |
263
- | :------ | :------ | :------ |
264
- | `value` | `any` | String para ser validada. |
304
+ **value**: `any`
305
+
306
+ String para ser validada.
265
307
 
266
308
  #### Returns
267
309
 
@@ -269,23 +311,23 @@ Valores null e undefined são considerados como vazio.
269
311
 
270
312
  - Verdadeiro caso a string não contenha informação.
271
313
 
272
- #### Defined in
314
+ #### Source
273
315
 
274
- src/utils/StringUtils.ts:16
316
+ src/utils/StringUtils.ts:18
275
317
 
276
- ___
318
+ ***
277
319
 
278
- ### isLowerCase
320
+ ### isLowerCase()
279
321
 
280
- `Static` **isLowerCase**(`original`): `boolean`
322
+ > `static` **isLowerCase**(`original`): `boolean`
281
323
 
282
324
  Checa se uma string é minúscula
283
325
 
284
326
  #### Parameters
285
327
 
286
- | Name | Type | Description |
287
- | :------ | :------ | :------ |
288
- | `original` | `string` | A string a ser verificada |
328
+ **original**: `string`
329
+
330
+ A string a ser verificada
289
331
 
290
332
  #### Returns
291
333
 
@@ -293,59 +335,51 @@ Checa se uma string é minúscula
293
335
 
294
336
  Se a string é minúscula
295
337
 
296
- #### Defined in
338
+ #### Source
297
339
 
298
- src/utils/StringUtils.ts:402
340
+ src/utils/StringUtils.ts:404
299
341
 
300
- ___
342
+ ***
301
343
 
302
- ### isString
344
+ ### isString()
303
345
 
304
- `Static` **isString**(`text`): `boolean`
346
+ > `static` **isString**(`text`): `boolean`
305
347
 
306
348
  Verifica se argumento informado é do tipo string
307
349
 
308
350
  #### Parameters
309
351
 
310
- | Name | Type |
311
- | :------ | :------ |
312
- | `text` | `any` |
352
+ **text**: `any`
313
353
 
314
354
  #### Returns
315
355
 
316
356
  `boolean`
317
357
 
318
- #### Defined in
358
+ #### Source
319
359
 
320
- src/utils/StringUtils.ts:36
360
+ src/utils/StringUtils.ts:38
321
361
 
322
- ___
362
+ ***
323
363
 
324
- ### padEnd
364
+ ### padEnd()
325
365
 
326
- `Static` **padEnd**(`str`, `len`, `pad?`): `string`
366
+ > `static` **padEnd**(`str`, `len`, `pad`): `string`
327
367
 
328
368
  Adiciona caracteres à direita caso texto seja menor que o valor do parâmetro len passado.
329
369
 
330
- **`Example`**
370
+ #### Parameters
331
371
 
332
- ```ts
333
- padStart('SANKHYA', 8,'.') | Retorna: 'SANKHYA...'
334
- ```
372
+ • **str**: `string`
335
373
 
336
- **`Example`**
374
+ Texto para ser ajustado.
337
375
 
338
- ```ts
339
- padStart('SANKHYA', 5,'A') | Retorna: 'SANKHYA'
340
- ```
376
+ • **len**: `number`
341
377
 
342
- #### Parameters
378
+ Tamanho desejado do texto.
379
+
380
+ • **pad**: `string`= `" "`
343
381
 
344
- | Name | Type | Default value | Description |
345
- | :------ | :------ | :------ | :------ |
346
- | `str` | `string` | `undefined` | Texto para ser ajustado. |
347
- | `len` | `number` | `undefined` | Tamanho desejado do texto. |
348
- | `pad` | `string` | `" "` | Caractere a ser adicionado a direita caso o texto menor que o tamanho passado. |
382
+ Caractere a ser adicionado a direita caso o texto menor que o tamanho passado.
349
383
 
350
384
  #### Returns
351
385
 
@@ -354,37 +388,41 @@ padStart('SANKHYA', 5,'A') | Retorna: 'SANKHYA'
354
388
  - Texto passado se este for maior que o len.
355
389
  Ou retorna o texto com os caracteres adicionados na direita.
356
390
 
357
- #### Defined in
391
+ #### Examples
392
+
393
+ ```ts
394
+ padStart('SANKHYA', 8,'.') | Retorna: 'SANKHYA...'
395
+ ```
396
+
397
+ ```ts
398
+ padStart('SANKHYA', 5,'A') | Retorna: 'SANKHYA'
399
+ ```
400
+
401
+ #### Source
358
402
 
359
- src/utils/StringUtils.ts:232
403
+ src/utils/StringUtils.ts:234
360
404
 
361
- ___
405
+ ***
362
406
 
363
- ### padStart
407
+ ### padStart()
364
408
 
365
- `Static` **padStart**(`str`, `len`, `pad?`): `string`
409
+ > `static` **padStart**(`str`, `len`, `pad`): `string`
366
410
 
367
411
  Adiciona caracteres à esquerda caso texto seja menor que o valor do parâmetro len passado.
368
412
 
369
- **`Example`**
413
+ #### Parameters
370
414
 
371
- ```ts
372
- padStart('SANKHYA', 8,'.') | Retorna: '...SANKHYA'
373
- ```
415
+ • **str**: `string`
374
416
 
375
- **`Example`**
417
+ Texto para ser ajustado.
376
418
 
377
- ```ts
378
- padStart('SANKHYA', 5,'A') | Retorna: 'SANKHYA'
379
- ```
419
+ • **len**: `number`
380
420
 
381
- #### Parameters
421
+ Tamanho desejado do texto.
422
+
423
+ • **pad**: `string`= `" "`
382
424
 
383
- | Name | Type | Default value | Description |
384
- | :------ | :------ | :------ | :------ |
385
- | `str` | `string` | `undefined` | Texto para ser ajustado. |
386
- | `len` | `number` | `undefined` | Tamanho desejado do texto. |
387
- | `pad` | `string` | `" "` | Caractere a ser adicionado a esquerda caso o texto menor que o tamanho passado. |
425
+ Caractere a ser adicionado a esquerda caso o texto menor que o tamanho passado.
388
426
 
389
427
  #### Returns
390
428
 
@@ -393,24 +431,34 @@ padStart('SANKHYA', 5,'A') | Retorna: 'SANKHYA'
393
431
  - Texto passado se este for maior que o len.
394
432
  Ou retorna o texto com os caracteres adicionados na esquerda.
395
433
 
396
- #### Defined in
434
+ #### Examples
397
435
 
398
- src/utils/StringUtils.ts:207
436
+ ```ts
437
+ padStart('SANKHYA', 8,'.') | Retorna: '...SANKHYA'
438
+ ```
399
439
 
400
- ___
440
+ ```ts
441
+ padStart('SANKHYA', 5,'A') | Retorna: 'SANKHYA'
442
+ ```
443
+
444
+ #### Source
401
445
 
402
- ### prettyPrecision
446
+ src/utils/StringUtils.ts:209
403
447
 
404
- ▸ `Static` `Private` **prettyPrecision**(`strNumber`): `string`
448
+ ***
449
+
450
+ ### prettyPrecision()
451
+
452
+ > `static` `private` **prettyPrecision**(`strNumber`): `string`
405
453
 
406
454
  Método interno. Remove zeros depois da vírgula diminuindo o tamanho
407
455
  da string.
408
456
 
409
457
  #### Parameters
410
458
 
411
- | Name | Type | Description |
412
- | :------ | :------ | :------ |
413
- | `strNumber` | `string` | representação textual do número a ser ajustado. |
459
+ **strNumber**: `string`
460
+
461
+ representação textual do número a ser ajustado.
414
462
 
415
463
  #### Returns
416
464
 
@@ -418,53 +466,92 @@ da string.
418
466
 
419
467
  simplificação do strNumber, sem os zeros à direita depois do ponto.
420
468
 
421
- #### Defined in
469
+ #### Source
470
+
471
+ src/utils/StringUtils.ts:360
472
+
473
+ ***
474
+
475
+ ### removeSpecialCharacters()
476
+
477
+ > `static` **removeSpecialCharacters**(`str`): `string`
478
+
479
+ #### Parameters
480
+
481
+ • **str**: `string`
482
+
483
+ #### Returns
422
484
 
423
- src/utils/StringUtils.ts:358
485
+ `string`
424
486
 
425
- ___
487
+ #### Source
426
488
 
427
- ### replaceAccentuatedChars
489
+ src/utils/StringUtils.ts:476
428
490
 
429
- ▸ `Static` **replaceAccentuatedChars**(`text`, `removeSpecialChars?`): `string`
491
+ ***
492
+
493
+ ### replaceAccentuatedChars()
494
+
495
+ > `static` **replaceAccentuatedChars**(`text`, `removeSpecialChars`): `string`
430
496
 
431
497
  Remove acentuação de vogais e de caracteres especiais que não sejam letras ou numeral.
432
498
 
433
- **`Example`**
499
+ #### Parameters
500
+
501
+ • **text**: `string`
502
+
503
+ String para ser transformada.
504
+
505
+ • **removeSpecialChars**: `boolean`= `true`
506
+
507
+ Remove outros caracteres especiais que não sejam letras e números.
508
+
509
+ #### Returns
510
+
511
+ `string`
512
+
513
+ #### Example
434
514
 
435
515
  ```ts
436
516
  entrada: "á@Êç#Ò", false // retorno: "a@Ec#O"
437
517
  entrada: "á@Êç#Ò", true // retorno: "aEcO"
438
518
  ```
439
519
 
520
+ #### Source
521
+
522
+ src/utils/StringUtils.ts:124
523
+
524
+ ***
525
+
526
+ ### replaceAccentuatedCharsHtmlEntities()
527
+
528
+ > `static` **replaceAccentuatedCharsHtmlEntities**(`source`): `string`
529
+
440
530
  #### Parameters
441
531
 
442
- | Name | Type | Default value | Description |
443
- | :------ | :------ | :------ | :------ |
444
- | `text` | `string` | `undefined` | String para ser transformada. |
445
- | `removeSpecialChars` | `boolean` | `true` | Remove outros caracteres especiais que não sejam letras e números. |
532
+ **source**: `string`
446
533
 
447
534
  #### Returns
448
535
 
449
536
  `string`
450
537
 
451
- #### Defined in
538
+ #### Source
452
539
 
453
- src/utils/StringUtils.ts:122
540
+ src/utils/StringUtils.ts:437
454
541
 
455
- ___
542
+ ***
456
543
 
457
- ### replaceAccentuatedCharsKeepSymbols
544
+ ### replaceAccentuatedCharsKeepSymbols()
458
545
 
459
- `Static` **replaceAccentuatedCharsKeepSymbols**(`text`): `string`
546
+ > `static` **replaceAccentuatedCharsKeepSymbols**(`text`): `string`
460
547
 
461
548
  Remove acentos de vogais, substitui Ç por c e retorna a string em caixa alta mantendo espaços e símbolos.
462
549
 
463
550
  #### Parameters
464
551
 
465
- | Name | Type | Description |
466
- | :------ | :------ | :------ |
467
- | `text` | `string` | Texto para ser transformado. |
552
+ **text**: `string`
553
+
554
+ Texto para ser transformado.
468
555
 
469
556
  #### Returns
470
557
 
@@ -472,79 +559,101 @@ Remove acentos de vogais, substitui Ç por c e retorna a string em caixa alta ma
472
559
 
473
560
  - Texto sem acentuação e caixa alta, mantendo espaços e símbolos.
474
561
 
475
- #### Defined in
562
+ #### Source
476
563
 
477
- src/utils/StringUtils.ts:141
564
+ src/utils/StringUtils.ts:143
478
565
 
479
- ___
566
+ ***
480
567
 
481
- ### replaceAccentuatedCharsLower
568
+ ### replaceAccentuatedCharsLower()
482
569
 
483
- `Static` **replaceAccentuatedCharsLower**(`text`): `string`
570
+ > `static` **replaceAccentuatedCharsLower**(`text`): `string`
484
571
 
485
572
  Remove acentos de vogais minúsculas.
486
573
 
487
- **`Example`**
574
+ #### Parameters
575
+
576
+ • **text**: `string`
577
+
578
+ String para ser transformada.
579
+
580
+ #### Returns
581
+
582
+ `string`
583
+
584
+ #### Example
488
585
 
489
586
  ```ts
490
587
  entrada: "áêçò" // retorno: "aeco"
491
588
  ```
492
589
 
493
- #### Parameters
590
+ #### Source
494
591
 
495
- | Name | Type | Description |
496
- | :------ | :------ | :------ |
497
- | `text` | `string` | String para ser transformada. |
592
+ src/utils/StringUtils.ts:101
498
593
 
499
- #### Returns
594
+ ***
500
595
 
501
- `string`
596
+ ### replaceAccentuatedCharsUpper()
502
597
 
503
- #### Defined in
598
+ > `static` **replaceAccentuatedCharsUpper**(`text`): `string`
504
599
 
505
- src/utils/StringUtils.ts:99
600
+ Remove acentos de vogais maiúsculas
506
601
 
507
- ___
602
+ #### Parameters
508
603
 
509
- ### replaceAccentuatedCharsUpper
604
+ **text**: `string`
510
605
 
511
- `Static` **replaceAccentuatedCharsUpper**(`text`): `string`
606
+ String para ser transformada.
512
607
 
513
- Remove acentos de vogais maiúsculas
608
+ #### Returns
514
609
 
515
- **`Example`**
610
+ `string`
611
+
612
+ #### Example
516
613
 
517
614
  ```ts
518
615
  entrada: "ÁÊÇÒ" // retorno: "AECO"
519
616
  ```
520
617
 
618
+ #### Source
619
+
620
+ src/utils/StringUtils.ts:49
621
+
622
+ ***
623
+
624
+ ### replaceAll()
625
+
626
+ > `static` **replaceAll**(`str`, `strFrom`, `strTo`): `string`
627
+
521
628
  #### Parameters
522
629
 
523
- | Name | Type | Description |
524
- | :------ | :------ | :------ |
525
- | `text` | `string` | String para ser transformada. |
630
+ **str**: `string`
631
+
632
+ **strFrom**: `string`
633
+
634
+ • **strTo**: `string`
526
635
 
527
636
  #### Returns
528
637
 
529
638
  `string`
530
639
 
531
- #### Defined in
640
+ #### Source
532
641
 
533
- src/utils/StringUtils.ts:47
642
+ src/utils/StringUtils.ts:467
534
643
 
535
- ___
644
+ ***
536
645
 
537
- ### replaceBlankCharacters
646
+ ### replaceBlankCharacters()
538
647
 
539
- `Static` **replaceBlankCharacters**(`value`): `string`
648
+ > `static` **replaceBlankCharacters**(`value`): `string`
540
649
 
541
650
  Utilitário para remover caracteres em branco da string.
542
651
 
543
652
  #### Parameters
544
653
 
545
- | Name | Type | Description |
546
- | :------ | :------ | :------ |
547
- | `value` | `string` | String a ser removido os espaços. |
654
+ **value**: `string`
655
+
656
+ String a ser removido os espaços.
548
657
 
549
658
  #### Returns
550
659
 
@@ -552,30 +661,44 @@ Utilitário para remover caracteres em branco da string.
552
661
 
553
662
  String sem espaços em branco.
554
663
 
555
- #### Defined in
664
+ #### Source
556
665
 
557
- src/utils/StringUtils.ts:323
666
+ src/utils/StringUtils.ts:325
558
667
 
559
- ___
668
+ ***
560
669
 
561
- ### toCamelCase
670
+ ### replaceToSpace()
562
671
 
563
- `Static` **toCamelCase**(`value`): `string`
672
+ > `static` **replaceToSpace**(`source`, `replaceList`): `string`
564
673
 
565
- Converte string em camelCase.
566
- Combina palavras compostas ou frases, alterando a inicial de cada uma, a partir da primeira, para maiúscula e unidas sem espaços.
674
+ #### Parameters
567
675
 
568
- **`Example`**
676
+ • **source**: `string`
569
677
 
570
- ```ts
571
- toCamelCase('Exemplo de uso') | Retorna: 'exemploDeUso'
572
- ```
678
+ • **replaceList**: `string`[]= `[]`
679
+
680
+ #### Returns
681
+
682
+ `string`
683
+
684
+ #### Source
685
+
686
+ src/utils/StringUtils.ts:420
687
+
688
+ ***
689
+
690
+ ### toCamelCase()
691
+
692
+ > `static` **toCamelCase**(`value`): `string`
693
+
694
+ Converte string em camelCase.
695
+ Combina palavras compostas ou frases, alterando a inicial de cada uma, a partir da primeira, para maiúscula e unidas sem espaços.
573
696
 
574
697
  #### Parameters
575
698
 
576
- | Name | Type | Description |
577
- | :------ | :------ | :------ |
578
- | `value` | `string` | String a ser convertida. |
699
+ **value**: `string`
700
+
701
+ String a ser convertida.
579
702
 
580
703
  #### Returns
581
704
 
@@ -583,23 +706,29 @@ toCamelCase('Exemplo de uso') | Retorna: 'exemploDeUso'
583
706
 
584
707
  String convertida em camelCase.
585
708
 
586
- #### Defined in
709
+ #### Example
710
+
711
+ ```ts
712
+ toCamelCase('Exemplo de uso') | Retorna: 'exemploDeUso'
713
+ ```
714
+
715
+ #### Source
587
716
 
588
- src/utils/StringUtils.ts:274
717
+ src/utils/StringUtils.ts:276
589
718
 
590
- ___
719
+ ***
591
720
 
592
- ### toKebabCase
721
+ ### toKebabCase()
593
722
 
594
- `Static` **toKebabCase**(`value`): `string`
723
+ > `static` **toKebabCase**(`value`): `string`
595
724
 
596
725
  Utilitário para converter string em kebab-case.
597
726
 
598
727
  #### Parameters
599
728
 
600
- | Name | Type | Description |
601
- | :------ | :------ | :------ |
602
- | `value` | `string` | String a ser convertida. |
729
+ **value**: `string`
730
+
731
+ String a ser convertida.
603
732
 
604
733
  #### Returns
605
734
 
@@ -607,23 +736,23 @@ Utilitário para converter string em kebab-case.
607
736
 
608
737
  String convertida em KebabCase.
609
738
 
610
- #### Defined in
739
+ #### Source
611
740
 
612
- src/utils/StringUtils.ts:314
741
+ src/utils/StringUtils.ts:316
613
742
 
614
- ___
743
+ ***
615
744
 
616
- ### toPascalCase
745
+ ### toPascalCase()
617
746
 
618
- `Static` **toPascalCase**(`value`): `string`
747
+ > `static` **toPascalCase**(`value`): `string`
619
748
 
620
749
  Converte string para PascalCase.
621
750
 
622
751
  #### Parameters
623
752
 
624
- | Name | Type | Description |
625
- | :------ | :------ | :------ |
626
- | `value` | `string` | String a ser convertida. |
753
+ **value**: `string`
754
+
755
+ String a ser convertida.
627
756
 
628
757
  #### Returns
629
758
 
@@ -631,23 +760,23 @@ Converte string para PascalCase.
631
760
 
632
761
  String convertida em PascalCase.
633
762
 
634
- #### Defined in
763
+ #### Source
635
764
 
636
- src/utils/StringUtils.ts:289
765
+ src/utils/StringUtils.ts:291
637
766
 
638
- ___
767
+ ***
639
768
 
640
- ### toSnakeCase
769
+ ### toSnakeCase()
641
770
 
642
- `Static` **toSnakeCase**(`value`): `string`
771
+ > `static` **toSnakeCase**(`value`): `string`
643
772
 
644
773
  Utilitário para converter string em snake_case.
645
774
 
646
775
  #### Parameters
647
776
 
648
- | Name | Type | Description |
649
- | :------ | :------ | :------ |
650
- | `value` | `string` | String a ser convertida. |
777
+ **value**: `string`
778
+
779
+ String a ser convertida.
651
780
 
652
781
  #### Returns
653
782
 
@@ -655,6 +784,6 @@ Utilitário para converter string em snake_case.
655
784
 
656
785
  String convertida em snake_case.
657
786
 
658
- #### Defined in
787
+ #### Source
659
788
 
660
- src/utils/StringUtils.ts:301
789
+ src/utils/StringUtils.ts:303