@sankhyalabs/core-docs 5.20.0-dev.5 → 5.20.0-dev.50
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.
- package/README.md +3 -1
- package/classes/ApplicationContext.md +31 -32
- package/classes/ArrayUtils.md +95 -83
- package/classes/AuthorizedServiceCaller.md +25 -34
- package/classes/Change.md +59 -74
- package/classes/DataUnit.md +1180 -1086
- package/classes/DataUnitAction.md +25 -42
- package/classes/DataUnitStorage.md +40 -43
- package/classes/DateUtils.md +140 -133
- package/classes/ElementIDUtils.md +123 -122
- package/classes/ErrorException.md +67 -88
- package/classes/ErrorTracking.md +20 -23
- package/classes/FieldComparator.md +35 -39
- package/classes/FloatingManager.md +195 -198
- package/classes/HTMLBuilder.md +14 -20
- package/classes/HttpProvider.md +45 -41
- package/classes/IDBRepository.md +201 -196
- package/classes/JSUtils.md +65 -66
- package/classes/KeyboardManager.md +95 -87
- package/classes/{MaskFormatter-1.md → MaskFormatter.md} +93 -128
- package/classes/NumberUtils.md +163 -152
- package/classes/ObjectUtils.md +206 -70
- package/classes/OnboardingUtils.md +36 -51
- package/classes/OverflowWatcher.md +533 -0
- package/classes/PromiseSync.md +25 -42
- package/classes/ReadyUtil.md +31 -41
- package/classes/RequestMetadata.md +29 -30
- package/classes/SearchUtils.md +18 -20
- package/classes/SelectionInfo.md +73 -74
- package/classes/ServiceCanceledException.md +193 -0
- package/classes/SkwHttpProvider.md +33 -45
- package/classes/StringUtils.md +297 -322
- package/classes/TimeFormatter.md +43 -44
- package/classes/UserAgentUtils.md +17 -20
- package/classes/VersionUtils.md +15 -18
- package/classes/WaitingChangeException.md +63 -84
- package/classes/WarningException.md +67 -88
- package/enumerations/Action.md +317 -0
- package/enumerations/ChangeOperation.md +47 -0
- package/enumerations/DataType.md +57 -0
- package/enumerations/DependencyType.md +37 -0
- package/enumerations/OverflowDirection.md +29 -0
- package/enumerations/SelectionMode.md +27 -0
- package/enumerations/SortMode.md +27 -0
- package/enumerations/UserInterface.md +177 -0
- package/functions/defaultDataLoader.md +25 -0
- package/{modules.md → globals.md} +27 -36
- package/interfaces/ChildDescriptor.md +12 -16
- package/interfaces/ChildLink.md +9 -12
- package/interfaces/DUActionInterceptor.md +10 -14
- package/interfaces/ExecutionContext.md +17 -32
- package/interfaces/FieldDescriptor.md +52 -66
- package/interfaces/Filter.md +13 -17
- package/interfaces/IElementIDInfo.md +11 -14
- package/interfaces/ILoadResult.md +11 -16
- package/interfaces/IRepository.md +106 -93
- package/interfaces/IRepositoryIndex.md +23 -30
- package/interfaces/LoadDataRequest.md +36 -45
- package/interfaces/LoadDataResponse.md +11 -14
- package/interfaces/OverFlowWatcherParams.md +67 -0
- package/interfaces/PageRequest.md +16 -20
- package/interfaces/PaginationInfo.md +24 -31
- package/interfaces/PromiseSyncCallback.md +13 -17
- package/interfaces/QuickFilter.md +17 -21
- package/interfaces/Record.md +26 -33
- package/interfaces/SavedRecord.md +33 -41
- package/interfaces/Sort.md +12 -16
- package/interfaces/SortingProvider.md +10 -13
- package/interfaces/UnitMetadata.md +16 -21
- package/interfaces/WaitingChange.md +16 -20
- package/namespaces/MaskFormatter/README.md +17 -0
- package/namespaces/MaskFormatter/type-aliases/MaskCharacter.md +13 -0
- package/namespaces/MaskFormatter/variables/MaskCharacter.md +13 -0
- package/package.json +1 -1
- package/type-aliases/DataUnitEventOptions.md +17 -0
- package/type-aliases/OnOverflowCallBack.md +25 -0
- package/variables/OVERFLOWED_CLASS_NAME.md +13 -0
- package/enums/Action.md +0 -305
- package/enums/ChangeOperation.md +0 -52
- package/enums/DataType.md +0 -63
- package/enums/DependencyType.md +0 -41
- package/enums/SelectionMode.md +0 -30
- package/enums/SortMode.md +0 -30
- package/enums/UserInterface.md +0 -195
- package/modules/MaskFormatter.md +0 -37
@@ -1,4 +1,8 @@
|
|
1
|
-
[
|
1
|
+
[**@sankhyalabs/core**](../README.md) • **Docs**
|
2
|
+
|
3
|
+
***
|
4
|
+
|
5
|
+
[@sankhyalabs/core](../globals.md) / MaskFormatter
|
2
6
|
|
3
7
|
# Class: MaskFormatter
|
4
8
|
|
@@ -46,54 +50,21 @@ resultaria na string '123-____'.
|
|
46
50
|
|PLACA (veículo) |UUU-#### |abc1234 |ABC-1234 |
|
47
51
|
|Cor RGB |'#AAAAAA |00000F0 |#0000F0 |
|
48
52
|
|
49
|
-
## Table of contents
|
50
|
-
|
51
|
-
### Constructors
|
52
|
-
|
53
|
-
- [constructor](MaskFormatter-1.md#constructor)
|
54
|
-
|
55
|
-
### Properties
|
56
|
-
|
57
|
-
- [\_mask](MaskFormatter-1.md#_mask)
|
58
|
-
- [\_maskChars](MaskFormatter-1.md#_maskchars)
|
59
|
-
- [placeholder](MaskFormatter-1.md#placeholder)
|
60
|
-
- [ALPHA\_NUMERIC\_KEY](MaskFormatter-1.md#alpha_numeric_key)
|
61
|
-
- [ANYTHING\_KEY](MaskFormatter-1.md#anything_key)
|
62
|
-
- [AlphaNumericCharacter](MaskFormatter-1.md#alphanumericcharacter)
|
63
|
-
- [CHARACTER\_KEY](MaskFormatter-1.md#character_key)
|
64
|
-
- [CharCharacter](MaskFormatter-1.md#charcharacter)
|
65
|
-
- [DEFAULT\_MASKS](MaskFormatter-1.md#default_masks)
|
66
|
-
- [DIGIT\_KEY](MaskFormatter-1.md#digit_key)
|
67
|
-
- [DigitMaskCharacter](MaskFormatter-1.md#digitmaskcharacter)
|
68
|
-
- [LITERAL\_KEY](MaskFormatter-1.md#literal_key)
|
69
|
-
- [LOWERCASE\_KEY](MaskFormatter-1.md#lowercase_key)
|
70
|
-
- [LiteralCharacter](MaskFormatter-1.md#literalcharacter)
|
71
|
-
- [LowerCaseCharacter](MaskFormatter-1.md#lowercasecharacter)
|
72
|
-
- [UPPERCASE\_KEY](MaskFormatter-1.md#uppercase_key)
|
73
|
-
- [UpperCaseCharacter](MaskFormatter-1.md#uppercasecharacter)
|
74
|
-
|
75
|
-
### Accessors
|
76
|
-
|
77
|
-
- [mask](MaskFormatter-1.md#mask)
|
78
|
-
|
79
|
-
### Methods
|
80
|
-
|
81
|
-
- [format](MaskFormatter-1.md#format)
|
82
|
-
- [updateInternalMask](MaskFormatter-1.md#updateinternalmask)
|
83
|
-
|
84
53
|
## Constructors
|
85
54
|
|
86
|
-
###
|
55
|
+
### new MaskFormatter()
|
87
56
|
|
88
|
-
|
57
|
+
> **new MaskFormatter**(`mask`): [`MaskFormatter`](MaskFormatter.md)
|
89
58
|
|
90
59
|
#### Parameters
|
91
60
|
|
92
|
-
|
93
|
-
|
94
|
-
|
61
|
+
• **mask**: `string`
|
62
|
+
|
63
|
+
#### Returns
|
64
|
+
|
65
|
+
[`MaskFormatter`](MaskFormatter.md)
|
95
66
|
|
96
|
-
####
|
67
|
+
#### Source
|
97
68
|
|
98
69
|
src/utils/MaskFormatter.ts:91
|
99
70
|
|
@@ -101,224 +72,218 @@ src/utils/MaskFormatter.ts:91
|
|
101
72
|
|
102
73
|
### \_mask
|
103
74
|
|
104
|
-
|
75
|
+
> `private` **\_mask**: `string` = `''`
|
105
76
|
|
106
|
-
####
|
77
|
+
#### Source
|
107
78
|
|
108
79
|
src/utils/MaskFormatter.ts:65
|
109
80
|
|
110
|
-
|
81
|
+
***
|
111
82
|
|
112
83
|
### \_maskChars
|
113
84
|
|
114
|
-
|
85
|
+
> `private` **\_maskChars**: `__class`[]
|
115
86
|
|
116
|
-
####
|
87
|
+
#### Source
|
117
88
|
|
118
89
|
src/utils/MaskFormatter.ts:66
|
119
90
|
|
120
|
-
|
91
|
+
***
|
121
92
|
|
122
93
|
### placeholder
|
123
94
|
|
124
|
-
|
95
|
+
> **placeholder**: `string` = `' '`
|
125
96
|
|
126
97
|
Determina qual caractere será usado dos caracteres não presentes no valor,
|
127
98
|
ou seja, aqueles que o usuário ainda não informou. Por padrão usamos um espaço.
|
128
99
|
|
129
|
-
####
|
100
|
+
#### Source
|
130
101
|
|
131
102
|
src/utils/MaskFormatter.ts:72
|
132
103
|
|
133
|
-
|
104
|
+
***
|
134
105
|
|
135
106
|
### ALPHA\_NUMERIC\_KEY
|
136
107
|
|
137
|
-
|
108
|
+
> `static` `private` **ALPHA\_NUMERIC\_KEY**: `string` = `"A"`
|
138
109
|
|
139
|
-
####
|
110
|
+
#### Source
|
140
111
|
|
141
112
|
src/utils/MaskFormatter.ts:53
|
142
113
|
|
143
|
-
|
114
|
+
***
|
144
115
|
|
145
116
|
### ANYTHING\_KEY
|
146
117
|
|
147
|
-
|
118
|
+
> `static` `private` **ANYTHING\_KEY**: `string` = `"*"`
|
148
119
|
|
149
|
-
####
|
120
|
+
#### Source
|
150
121
|
|
151
122
|
src/utils/MaskFormatter.ts:55
|
152
123
|
|
153
|
-
|
124
|
+
***
|
154
125
|
|
155
126
|
### AlphaNumericCharacter
|
156
127
|
|
157
|
-
|
128
|
+
> `static` `private` **AlphaNumericCharacter**: *typeof* `__class`
|
158
129
|
|
159
|
-
####
|
130
|
+
#### Source
|
160
131
|
|
161
|
-
src/utils/MaskFormatter.ts:
|
132
|
+
src/utils/MaskFormatter.ts:379
|
162
133
|
|
163
|
-
|
134
|
+
***
|
164
135
|
|
165
136
|
### CHARACTER\_KEY
|
166
137
|
|
167
|
-
|
138
|
+
> `static` `private` **CHARACTER\_KEY**: `string` = `"?"`
|
168
139
|
|
169
|
-
####
|
140
|
+
#### Source
|
170
141
|
|
171
142
|
src/utils/MaskFormatter.ts:54
|
172
143
|
|
173
|
-
|
144
|
+
***
|
174
145
|
|
175
146
|
### CharCharacter
|
176
147
|
|
177
|
-
|
148
|
+
> `static` `private` **CharCharacter**: *typeof* `__class`
|
178
149
|
|
179
|
-
####
|
150
|
+
#### Source
|
180
151
|
|
181
|
-
src/utils/MaskFormatter.ts:
|
152
|
+
src/utils/MaskFormatter.ts:393
|
182
153
|
|
183
|
-
|
154
|
+
***
|
184
155
|
|
185
156
|
### DEFAULT\_MASKS
|
186
157
|
|
187
|
-
|
158
|
+
> `static` **DEFAULT\_MASKS**: `any`
|
188
159
|
|
189
|
-
####
|
160
|
+
#### Source
|
190
161
|
|
191
162
|
src/utils/MaskFormatter.ts:57
|
192
163
|
|
193
|
-
|
164
|
+
***
|
194
165
|
|
195
166
|
### DIGIT\_KEY
|
196
167
|
|
197
|
-
|
168
|
+
> `static` `private` **DIGIT\_KEY**: `string` = `"#"`
|
198
169
|
|
199
|
-
####
|
170
|
+
#### Source
|
200
171
|
|
201
172
|
src/utils/MaskFormatter.ts:49
|
202
173
|
|
203
|
-
|
174
|
+
***
|
204
175
|
|
205
176
|
### DigitMaskCharacter
|
206
177
|
|
207
|
-
|
178
|
+
> `static` `private` **DigitMaskCharacter**: *typeof* `__class`
|
208
179
|
|
209
|
-
####
|
180
|
+
#### Source
|
210
181
|
|
211
|
-
src/utils/MaskFormatter.ts:
|
182
|
+
src/utils/MaskFormatter.ts:304
|
212
183
|
|
213
|
-
|
184
|
+
***
|
214
185
|
|
215
186
|
### LITERAL\_KEY
|
216
187
|
|
217
|
-
|
188
|
+
> `static` `private` **LITERAL\_KEY**: `string` = `"'"`
|
218
189
|
|
219
|
-
####
|
190
|
+
#### Source
|
220
191
|
|
221
192
|
src/utils/MaskFormatter.ts:50
|
222
193
|
|
223
|
-
|
194
|
+
***
|
224
195
|
|
225
196
|
### LOWERCASE\_KEY
|
226
197
|
|
227
|
-
|
198
|
+
> `static` `private` **LOWERCASE\_KEY**: `string` = `"L"`
|
228
199
|
|
229
|
-
####
|
200
|
+
#### Source
|
230
201
|
|
231
202
|
src/utils/MaskFormatter.ts:52
|
232
203
|
|
233
|
-
|
204
|
+
***
|
234
205
|
|
235
206
|
### LiteralCharacter
|
236
207
|
|
237
|
-
|
208
|
+
> `static` `private` **LiteralCharacter**: *typeof* `__class`
|
238
209
|
|
239
|
-
####
|
210
|
+
#### Source
|
240
211
|
|
241
|
-
src/utils/MaskFormatter.ts:
|
212
|
+
src/utils/MaskFormatter.ts:285
|
242
213
|
|
243
|
-
|
214
|
+
***
|
244
215
|
|
245
216
|
### LowerCaseCharacter
|
246
217
|
|
247
|
-
|
218
|
+
> `static` `private` **LowerCaseCharacter**: *typeof* `__class`
|
248
219
|
|
249
|
-
####
|
220
|
+
#### Source
|
250
221
|
|
251
|
-
src/utils/MaskFormatter.ts:
|
222
|
+
src/utils/MaskFormatter.ts:356
|
252
223
|
|
253
|
-
|
224
|
+
***
|
254
225
|
|
255
226
|
### UPPERCASE\_KEY
|
256
227
|
|
257
|
-
|
228
|
+
> `static` `private` **UPPERCASE\_KEY**: `string` = `"U"`
|
258
229
|
|
259
|
-
####
|
230
|
+
#### Source
|
260
231
|
|
261
232
|
src/utils/MaskFormatter.ts:51
|
262
233
|
|
263
|
-
|
234
|
+
***
|
264
235
|
|
265
236
|
### UpperCaseCharacter
|
266
237
|
|
267
|
-
|
238
|
+
> `static` `private` **UpperCaseCharacter**: *typeof* `__class`
|
268
239
|
|
269
|
-
####
|
240
|
+
#### Source
|
270
241
|
|
271
|
-
src/utils/MaskFormatter.ts:
|
242
|
+
src/utils/MaskFormatter.ts:333
|
272
243
|
|
273
244
|
## Accessors
|
274
245
|
|
275
246
|
### mask
|
276
247
|
|
277
|
-
|
248
|
+
> `get` **mask**(): `string`
|
278
249
|
|
279
250
|
Getter para mask.
|
280
251
|
|
281
|
-
|
282
|
-
|
283
|
-
`string`
|
284
|
-
|
285
|
-
A última máscara informada.
|
286
|
-
|
287
|
-
#### Defined in
|
288
|
-
|
289
|
-
src/utils/MaskFormatter.ts:87
|
290
|
-
|
291
|
-
• `set` **mask**(`mask`): `void`
|
252
|
+
> `set` **mask**(`mask`): `void`
|
292
253
|
|
293
254
|
Setter para mask. Trata-se do padrão que se espera ao formatar o texto.
|
294
255
|
|
295
256
|
#### Parameters
|
296
257
|
|
297
|
-
|
298
|
-
| :------ | :------ |
|
299
|
-
| `mask` | `string` |
|
258
|
+
• **mask**: `string`
|
300
259
|
|
301
260
|
#### Returns
|
302
261
|
|
303
|
-
`
|
262
|
+
`string`
|
263
|
+
|
264
|
+
A última máscara informada.
|
304
265
|
|
305
|
-
####
|
266
|
+
#### Source
|
306
267
|
|
307
|
-
src/utils/MaskFormatter.ts:
|
268
|
+
src/utils/MaskFormatter.ts:87
|
308
269
|
|
309
270
|
## Methods
|
310
271
|
|
311
|
-
### format
|
272
|
+
### format()
|
312
273
|
|
313
|
-
|
274
|
+
> **format**(`value`, `trimBefore`): `string`
|
314
275
|
|
315
276
|
Formata a string passada baseada na máscara definda pelo atributo mask.
|
316
277
|
|
317
278
|
#### Parameters
|
318
279
|
|
319
|
-
|
320
|
-
|
321
|
-
|
280
|
+
• **value**: `string`
|
281
|
+
|
282
|
+
Valor a ser formatado.
|
283
|
+
|
284
|
+
• **trimBefore**: `boolean`= `false`
|
285
|
+
|
286
|
+
Executa um trim para remover espaços em branco.
|
322
287
|
|
323
288
|
#### Returns
|
324
289
|
|
@@ -326,15 +291,15 @@ Formata a string passada baseada na máscara definda pelo atributo mask.
|
|
326
291
|
|
327
292
|
O valor processado de acordo com o padrão.
|
328
293
|
|
329
|
-
####
|
294
|
+
#### Source
|
330
295
|
|
331
|
-
src/utils/MaskFormatter.ts:
|
296
|
+
src/utils/MaskFormatter.ts:102
|
332
297
|
|
333
|
-
|
298
|
+
***
|
334
299
|
|
335
|
-
### updateInternalMask
|
300
|
+
### updateInternalMask()
|
336
301
|
|
337
|
-
|
302
|
+
> `private` **updateInternalMask**(): `void`
|
338
303
|
|
339
304
|
Prepara a formatação internamente de acordo com o padrão.
|
340
305
|
|
@@ -342,6 +307,6 @@ Prepara a formatação internamente de acordo com o padrão.
|
|
342
307
|
|
343
308
|
`void`
|
344
309
|
|
345
|
-
####
|
310
|
+
#### Source
|
346
311
|
|
347
|
-
src/utils/MaskFormatter.ts:
|
312
|
+
src/utils/MaskFormatter.ts:122
|