@sankhyalabs/core-docs 5.20.0-dev.5 → 5.20.0-dev.6

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