@sankhyalabs/core-docs 3.1.2 → 4.0.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.
@@ -0,0 +1,116 @@
1
+ [@sankhyalabs/core](../README.md) / [Exports](../modules.md) / DataUnitStorage
2
+
3
+ # Class: DataUnitStorage
4
+
5
+ Classe responsável por armazenar instâncias de DataUnit.
6
+
7
+ ## Table of contents
8
+
9
+ ### Constructors
10
+
11
+ - [constructor](DataUnitStorage.md#constructor)
12
+
13
+ ### Properties
14
+
15
+ - [dataUnitMap](DataUnitStorage.md#dataunitmap)
16
+ - [keyMap](DataUnitStorage.md#keymap)
17
+
18
+ ### Methods
19
+
20
+ - [get](DataUnitStorage.md#get)
21
+ - [put](DataUnitStorage.md#put)
22
+ - [remove](DataUnitStorage.md#remove)
23
+
24
+ ## Constructors
25
+
26
+ ### constructor
27
+
28
+ • **new DataUnitStorage**()
29
+
30
+ ## Properties
31
+
32
+ ### dataUnitMap
33
+
34
+ ▪ `Static` `Private` **dataUnitMap**: `WeakMap`<{ `key`: `string` }, [`DataUnit`](DataUnit.md)\>
35
+
36
+ #### Defined in
37
+
38
+ src/dataunit/DataUnitStorage.ts:7
39
+
40
+ ___
41
+
42
+ ### keyMap
43
+
44
+ ▪ `Static` `Private` **keyMap**: `Map`<`string`, { `key`: `string` }\>
45
+
46
+ #### Defined in
47
+
48
+ src/dataunit/DataUnitStorage.ts:8
49
+
50
+ ## Methods
51
+
52
+ ### get
53
+
54
+ ▸ `Static` **get**(`dataUnitName`): `undefined` \| [`DataUnit`](DataUnit.md)
55
+
56
+ Retorna uma instância de DataUnit armazenada no DataUnitStorage.
57
+
58
+ #### Parameters
59
+
60
+ | Name | Type | Description |
61
+ | :------ | :------ | :------ |
62
+ | `dataUnitName` | `string` | O nome do DataUnit. |
63
+
64
+ #### Returns
65
+
66
+ `undefined` \| [`DataUnit`](DataUnit.md)
67
+
68
+ - A instância do DataUnit ou undefined caso não seja encontrada.
69
+
70
+ #### Defined in
71
+
72
+ src/dataunit/DataUnitStorage.ts:15
73
+
74
+ ___
75
+
76
+ ### put
77
+
78
+ ▸ `Static` **put**(`dataUnit`): `void`
79
+
80
+ Armazena uma instância de DataUnit no DataUnitStorage.
81
+
82
+ #### Parameters
83
+
84
+ | Name | Type | Description |
85
+ | :------ | :------ | :------ |
86
+ | `dataUnit` | [`DataUnit`](DataUnit.md) | A instância de DataUnit a ser armazenada. |
87
+
88
+ #### Returns
89
+
90
+ `void`
91
+
92
+ #### Defined in
93
+
94
+ src/dataunit/DataUnitStorage.ts:24
95
+
96
+ ___
97
+
98
+ ### remove
99
+
100
+ ▸ `Static` **remove**(`dataUnit`): `void`
101
+
102
+ Remove uma instância de DataUnit do DataUnitStorage.
103
+
104
+ #### Parameters
105
+
106
+ | Name | Type | Description |
107
+ | :------ | :------ | :------ |
108
+ | `dataUnit` | `string` \| [`DataUnit`](DataUnit.md) | A instância de DataUnit ou o nome do DataUnit a ser removido. |
109
+
110
+ #### Returns
111
+
112
+ `void`
113
+
114
+ #### Defined in
115
+
116
+ src/dataunit/DataUnitStorage.ts:34
@@ -14,7 +14,10 @@
14
14
 
15
15
  - [adjustDLST](DateUtils.md#adjustdlst)
16
16
  - [clearTime](DateUtils.md#cleartime)
17
+ - [formatDate](DateUtils.md#formatdate)
18
+ - [formatDateTime](DateUtils.md#formatdatetime)
17
19
  - [formatRfc3339](DateUtils.md#formatrfc3339)
20
+ - [formatTime](DateUtils.md#formattime)
18
21
  - [getToday](DateUtils.md#gettoday)
19
22
  - [pad](DateUtils.md#pad)
20
23
  - [strToDate](DateUtils.md#strtodate)
@@ -49,7 +52,7 @@ Realiza correção do horário de verão.
49
52
 
50
53
  #### Defined in
51
54
 
52
- src/utils/DateUtils.ts:101
55
+ src/utils/DateUtils.ts:134
53
56
 
54
57
  ___
55
58
 
@@ -84,6 +87,55 @@ src/utils/DateUtils.ts:17
84
87
 
85
88
  ___
86
89
 
90
+ ### formatDate
91
+
92
+ ▸ `Static` **formatDate**(`date`): `string`
93
+
94
+ Converte data para uma string no formato pt-BR.
95
+
96
+ #### Parameters
97
+
98
+ | Name | Type | Description |
99
+ | :------ | :------ | :------ |
100
+ | `date` | `Date` | Data a ser convertida. |
101
+
102
+ #### Returns
103
+
104
+ `string`
105
+
106
+ - Uma string com a data no formato pt-BR DD/MM/YYYY.
107
+
108
+ #### Defined in
109
+
110
+ src/utils/DateUtils.ts:28
111
+
112
+ ___
113
+
114
+ ### formatDateTime
115
+
116
+ ▸ `Static` **formatDateTime**(`date`, `showSeconds?`): `string`
117
+
118
+ Converte a data e hora para uma string no formato pt-BR.
119
+
120
+ #### Parameters
121
+
122
+ | Name | Type | Default value | Description |
123
+ | :------ | :------ | :------ | :------ |
124
+ | `date` | `Date` | `undefined` | Data a ser convertida. |
125
+ | `showSeconds` | `boolean` | `false` | define se devemos considerar os segundos. |
126
+
127
+ #### Returns
128
+
129
+ `string`
130
+
131
+ - Uma string com as horas no formato DD/MM/YYYY HH:MM ou DD/MM/YYYY HH:MM:SS.
132
+
133
+ #### Defined in
134
+
135
+ src/utils/DateUtils.ts:51
136
+
137
+ ___
138
+
87
139
  ### formatRfc3339
88
140
 
89
141
  ▸ `Static` **formatRfc3339**(`date`): `string`
@@ -111,7 +163,32 @@ Informo: 2023-03-09 12:42:40 | Obtenho: 2023-03-09T12:42:47-03:00
111
163
 
112
164
  #### Defined in
113
165
 
114
- src/utils/DateUtils.ts:151
166
+ src/utils/DateUtils.ts:184
167
+
168
+ ___
169
+
170
+ ### formatTime
171
+
172
+ ▸ `Static` **formatTime**(`date`, `showSeconds?`): `string`
173
+
174
+ Converte as horas de uma data para uma string pt-BR.
175
+
176
+ #### Parameters
177
+
178
+ | Name | Type | Default value | Description |
179
+ | :------ | :------ | :------ | :------ |
180
+ | `date` | `Date` | `undefined` | Data a ser convertida. |
181
+ | `showSeconds` | `boolean` | `false` | define se devemos considerar os segundos. |
182
+
183
+ #### Returns
184
+
185
+ `string`
186
+
187
+ - Uma string com as horas no formato HH:MM ou HH:MM:SS.
188
+
189
+ #### Defined in
190
+
191
+ src/utils/DateUtils.ts:39
115
192
 
116
193
  ___
117
194
 
@@ -135,13 +212,13 @@ Obtém a data atual.
135
212
 
136
213
  #### Defined in
137
214
 
138
- src/utils/DateUtils.ts:72
215
+ src/utils/DateUtils.ts:105
139
216
 
140
217
  ___
141
218
 
142
219
  ### pad
143
220
 
144
- ▸ `Static` `Private` **pad**(`n`): `string` \| `Number`
221
+ ▸ `Static` `Private` **pad**(`n`): `string` \| `number`
145
222
 
146
223
  Adiciona uma casa decimal a esquerda de uma unidade.
147
224
 
@@ -161,17 +238,17 @@ Informo: 2 | Obtenho: "02"
161
238
 
162
239
  | Name | Type | Description |
163
240
  | :------ | :------ | :------ |
164
- | `n` | `Number` | Número a ser ajustado |
241
+ | `n` | `number` | Número a ser ajustado |
165
242
 
166
243
  #### Returns
167
244
 
168
- `string` \| `Number`
245
+ `string` \| `number`
169
246
 
170
247
  - O número informado, com uma casa decimal a esquerda.
171
248
 
172
249
  #### Defined in
173
250
 
174
- src/utils/DateUtils.ts:120
251
+ src/utils/DateUtils.ts:153
175
252
 
176
253
  ___
177
254
 
@@ -197,7 +274,7 @@ Converte String para Date.
197
274
 
198
275
  #### Defined in
199
276
 
200
- src/utils/DateUtils.ts:30
277
+ src/utils/DateUtils.ts:63
201
278
 
202
279
  ___
203
280
 
@@ -221,7 +298,7 @@ Timezone da data.
221
298
 
222
299
  #### Defined in
223
300
 
224
- src/utils/DateUtils.ts:130
301
+ src/utils/DateUtils.ts:163
225
302
 
226
303
  ___
227
304
 
@@ -246,4 +323,4 @@ Retorna se a data é válida.
246
323
 
247
324
  #### Defined in
248
325
 
249
- src/utils/DateUtils.ts:89
326
+ src/utils/DateUtils.ts:122
@@ -62,6 +62,7 @@ resultaria na string '123-____'.
62
62
  - [AlphaNumericCharacter](MaskFormatter-1.md#alphanumericcharacter)
63
63
  - [CHARACTER\_KEY](MaskFormatter-1.md#character_key)
64
64
  - [CharCharacter](MaskFormatter-1.md#charcharacter)
65
+ - [DEFAULT\_MASKS](MaskFormatter-1.md#default_masks)
65
66
  - [DIGIT\_KEY](MaskFormatter-1.md#digit_key)
66
67
  - [DigitMaskCharacter](MaskFormatter-1.md#digitmaskcharacter)
67
68
  - [LITERAL\_KEY](MaskFormatter-1.md#literal_key)
@@ -94,7 +95,7 @@ resultaria na string '123-____'.
94
95
 
95
96
  #### Defined in
96
97
 
97
- src/utils/MaskFormatter.ts:83
98
+ src/utils/MaskFormatter.ts:91
98
99
 
99
100
  ## Properties
100
101
 
@@ -104,7 +105,7 @@ src/utils/MaskFormatter.ts:83
104
105
 
105
106
  #### Defined in
106
107
 
107
- src/utils/MaskFormatter.ts:57
108
+ src/utils/MaskFormatter.ts:65
108
109
 
109
110
  ___
110
111
 
@@ -114,7 +115,7 @@ ___
114
115
 
115
116
  #### Defined in
116
117
 
117
- src/utils/MaskFormatter.ts:58
118
+ src/utils/MaskFormatter.ts:66
118
119
 
119
120
  ___
120
121
 
@@ -127,7 +128,7 @@ ou seja, aqueles que o usuário ainda não informou. Por padrão usamos um espa
127
128
 
128
129
  #### Defined in
129
130
 
130
- src/utils/MaskFormatter.ts:64
131
+ src/utils/MaskFormatter.ts:72
131
132
 
132
133
  ___
133
134
 
@@ -157,7 +158,7 @@ ___
157
158
 
158
159
  #### Defined in
159
160
 
160
- src/utils/MaskFormatter.ts:367
161
+ src/utils/MaskFormatter.ts:375
161
162
 
162
163
  ___
163
164
 
@@ -177,7 +178,17 @@ ___
177
178
 
178
179
  #### Defined in
179
180
 
180
- src/utils/MaskFormatter.ts:381
181
+ src/utils/MaskFormatter.ts:389
182
+
183
+ ___
184
+
185
+ ### DEFAULT\_MASKS
186
+
187
+ ▪ `Static` **DEFAULT\_MASKS**: `any`
188
+
189
+ #### Defined in
190
+
191
+ src/utils/MaskFormatter.ts:57
181
192
 
182
193
  ___
183
194
 
@@ -197,7 +208,7 @@ ___
197
208
 
198
209
  #### Defined in
199
210
 
200
- src/utils/MaskFormatter.ts:292
211
+ src/utils/MaskFormatter.ts:300
201
212
 
202
213
  ___
203
214
 
@@ -227,7 +238,7 @@ ___
227
238
 
228
239
  #### Defined in
229
240
 
230
- src/utils/MaskFormatter.ts:273
241
+ src/utils/MaskFormatter.ts:281
231
242
 
232
243
  ___
233
244
 
@@ -237,7 +248,7 @@ ___
237
248
 
238
249
  #### Defined in
239
250
 
240
- src/utils/MaskFormatter.ts:344
251
+ src/utils/MaskFormatter.ts:352
241
252
 
242
253
  ___
243
254
 
@@ -257,7 +268,7 @@ ___
257
268
 
258
269
  #### Defined in
259
270
 
260
- src/utils/MaskFormatter.ts:321
271
+ src/utils/MaskFormatter.ts:329
261
272
 
262
273
  ## Accessors
263
274
 
@@ -275,7 +286,7 @@ A última máscara informada.
275
286
 
276
287
  #### Defined in
277
288
 
278
- src/utils/MaskFormatter.ts:79
289
+ src/utils/MaskFormatter.ts:87
279
290
 
280
291
  • `set` **mask**(`mask`): `void`
281
292
 
@@ -293,7 +304,7 @@ Setter para mask. Trata-se do padrão que se espera ao formatar o texto.
293
304
 
294
305
  #### Defined in
295
306
 
296
- src/utils/MaskFormatter.ts:69
307
+ src/utils/MaskFormatter.ts:77
297
308
 
298
309
  ## Methods
299
310
 
@@ -317,7 +328,7 @@ O valor processado de acordo com o padrão.
317
328
 
318
329
  #### Defined in
319
330
 
320
- src/utils/MaskFormatter.ts:93
331
+ src/utils/MaskFormatter.ts:101
321
332
 
322
333
  ___
323
334
 
@@ -333,4 +344,4 @@ Prepara a formatação internamente de acordo com o padrão.
333
344
 
334
345
  #### Defined in
335
346
 
336
- src/utils/MaskFormatter.ts:110
347
+ src/utils/MaskFormatter.ts:118
package/enums/Action.md CHANGED
@@ -9,6 +9,7 @@
9
9
  - [CHANGE\_REDONE](Action.md#change_redone)
10
10
  - [CHANGE\_UNDONE](Action.md#change_undone)
11
11
  - [CHANGING\_DATA](Action.md#changing_data)
12
+ - [CHILD\_CHANGED](Action.md#child_changed)
12
13
  - [DATA\_CHANGED](Action.md#data_changed)
13
14
  - [DATA\_LOADED](Action.md#data_loaded)
14
15
  - [DATA\_SAVED](Action.md#data_saved)
@@ -61,6 +62,16 @@ src/dataunit/state/action/DataUnitAction.ts:44
61
62
 
62
63
  ___
63
64
 
65
+ ### CHILD\_CHANGED
66
+
67
+ • **CHILD\_CHANGED** = ``"childChanged"``
68
+
69
+ #### Defined in
70
+
71
+ src/dataunit/state/action/DataUnitAction.ts:61
72
+
73
+ ___
74
+
64
75
  ### DATA\_CHANGED
65
76
 
66
77
  • **DATA\_CHANGED** = ``"dataChanged"``
@@ -19,7 +19,7 @@
19
19
 
20
20
  #### Defined in
21
21
 
22
- src/dataunit/DataUnit.ts:1209
22
+ src/dataunit/DataUnit.ts:1425
23
23
 
24
24
  ___
25
25
 
@@ -29,7 +29,7 @@ ___
29
29
 
30
30
  #### Defined in
31
31
 
32
- src/dataunit/DataUnit.ts:1211
32
+ src/dataunit/DataUnit.ts:1427
33
33
 
34
34
  ___
35
35
 
@@ -39,7 +39,7 @@ ___
39
39
 
40
40
  #### Defined in
41
41
 
42
- src/dataunit/DataUnit.ts:1208
42
+ src/dataunit/DataUnit.ts:1424
43
43
 
44
44
  ___
45
45
 
@@ -49,4 +49,4 @@ ___
49
49
 
50
50
  #### Defined in
51
51
 
52
- src/dataunit/DataUnit.ts:1210
52
+ src/dataunit/DataUnit.ts:1426
@@ -18,7 +18,7 @@
18
18
 
19
19
  #### Defined in
20
20
 
21
- src/dataunit/metadata/UnitMetadata.ts:74
21
+ src/dataunit/metadata/UnitMetadata.ts:75
22
22
 
23
23
  ___
24
24
 
@@ -28,7 +28,7 @@ ___
28
28
 
29
29
  #### Defined in
30
30
 
31
- src/dataunit/metadata/UnitMetadata.ts:73
31
+ src/dataunit/metadata/UnitMetadata.ts:74
32
32
 
33
33
  ___
34
34
 
@@ -38,4 +38,4 @@ ___
38
38
 
39
39
  #### Defined in
40
40
 
41
- src/dataunit/metadata/UnitMetadata.ts:75
41
+ src/dataunit/metadata/UnitMetadata.ts:76
package/enums/SortMode.md CHANGED
@@ -17,7 +17,7 @@
17
17
 
18
18
  #### Defined in
19
19
 
20
- src/dataunit/metadata/UnitMetadata.ts:68
20
+ src/dataunit/metadata/UnitMetadata.ts:69
21
21
 
22
22
  ___
23
23
 
@@ -27,4 +27,4 @@ ___
27
27
 
28
28
  #### Defined in
29
29
 
30
- src/dataunit/metadata/UnitMetadata.ts:69
30
+ src/dataunit/metadata/UnitMetadata.ts:70
@@ -32,7 +32,7 @@
32
32
 
33
33
  #### Defined in
34
34
 
35
- src/dataunit/metadata/UnitMetadata.ts:85
35
+ src/dataunit/metadata/UnitMetadata.ts:86
36
36
 
37
37
  ___
38
38
 
@@ -42,7 +42,7 @@ ___
42
42
 
43
43
  #### Defined in
44
44
 
45
- src/dataunit/metadata/UnitMetadata.ts:81
45
+ src/dataunit/metadata/UnitMetadata.ts:82
46
46
 
47
47
  ___
48
48
 
@@ -52,7 +52,7 @@ ___
52
52
 
53
53
  #### Defined in
54
54
 
55
- src/dataunit/metadata/UnitMetadata.ts:82
55
+ src/dataunit/metadata/UnitMetadata.ts:83
56
56
 
57
57
  ___
58
58
 
@@ -62,7 +62,7 @@ ___
62
62
 
63
63
  #### Defined in
64
64
 
65
- src/dataunit/metadata/UnitMetadata.ts:88
65
+ src/dataunit/metadata/UnitMetadata.ts:89
66
66
 
67
67
  ___
68
68
 
@@ -72,7 +72,7 @@ ___
72
72
 
73
73
  #### Defined in
74
74
 
75
- src/dataunit/metadata/UnitMetadata.ts:84
75
+ src/dataunit/metadata/UnitMetadata.ts:85
76
76
 
77
77
  ___
78
78
 
@@ -82,7 +82,7 @@ ___
82
82
 
83
83
  #### Defined in
84
84
 
85
- src/dataunit/metadata/UnitMetadata.ts:79
85
+ src/dataunit/metadata/UnitMetadata.ts:80
86
86
 
87
87
  ___
88
88
 
@@ -92,7 +92,7 @@ ___
92
92
 
93
93
  #### Defined in
94
94
 
95
- src/dataunit/metadata/UnitMetadata.ts:95
95
+ src/dataunit/metadata/UnitMetadata.ts:96
96
96
 
97
97
  ___
98
98
 
@@ -102,7 +102,7 @@ ___
102
102
 
103
103
  #### Defined in
104
104
 
105
- src/dataunit/metadata/UnitMetadata.ts:80
105
+ src/dataunit/metadata/UnitMetadata.ts:81
106
106
 
107
107
  ___
108
108
 
@@ -112,7 +112,7 @@ ___
112
112
 
113
113
  #### Defined in
114
114
 
115
- src/dataunit/metadata/UnitMetadata.ts:89
115
+ src/dataunit/metadata/UnitMetadata.ts:90
116
116
 
117
117
  ___
118
118
 
@@ -122,7 +122,7 @@ ___
122
122
 
123
123
  #### Defined in
124
124
 
125
- src/dataunit/metadata/UnitMetadata.ts:94
125
+ src/dataunit/metadata/UnitMetadata.ts:95
126
126
 
127
127
  ___
128
128
 
@@ -132,7 +132,7 @@ ___
132
132
 
133
133
  #### Defined in
134
134
 
135
- src/dataunit/metadata/UnitMetadata.ts:93
135
+ src/dataunit/metadata/UnitMetadata.ts:94
136
136
 
137
137
  ___
138
138
 
@@ -142,7 +142,7 @@ ___
142
142
 
143
143
  #### Defined in
144
144
 
145
- src/dataunit/metadata/UnitMetadata.ts:87
145
+ src/dataunit/metadata/UnitMetadata.ts:88
146
146
 
147
147
  ___
148
148
 
@@ -152,7 +152,7 @@ ___
152
152
 
153
153
  #### Defined in
154
154
 
155
- src/dataunit/metadata/UnitMetadata.ts:92
155
+ src/dataunit/metadata/UnitMetadata.ts:93
156
156
 
157
157
  ___
158
158
 
@@ -162,7 +162,7 @@ ___
162
162
 
163
163
  #### Defined in
164
164
 
165
- src/dataunit/metadata/UnitMetadata.ts:90
165
+ src/dataunit/metadata/UnitMetadata.ts:91
166
166
 
167
167
  ___
168
168
 
@@ -172,7 +172,7 @@ ___
172
172
 
173
173
  #### Defined in
174
174
 
175
- src/dataunit/metadata/UnitMetadata.ts:91
175
+ src/dataunit/metadata/UnitMetadata.ts:92
176
176
 
177
177
  ___
178
178
 
@@ -182,7 +182,7 @@ ___
182
182
 
183
183
  #### Defined in
184
184
 
185
- src/dataunit/metadata/UnitMetadata.ts:86
185
+ src/dataunit/metadata/UnitMetadata.ts:87
186
186
 
187
187
  ___
188
188
 
@@ -192,4 +192,4 @@ ___
192
192
 
193
193
  #### Defined in
194
194
 
195
- src/dataunit/metadata/UnitMetadata.ts:83
195
+ src/dataunit/metadata/UnitMetadata.ts:84
@@ -0,0 +1,41 @@
1
+ [@sankhyalabs/core](../README.md) / [Exports](../modules.md) / ChildDescriptor
2
+
3
+ # Interface: ChildDescriptor
4
+
5
+ ## Table of contents
6
+
7
+ ### Properties
8
+
9
+ - [label](ChildDescriptor.md#label)
10
+ - [links](ChildDescriptor.md#links)
11
+ - [name](ChildDescriptor.md#name)
12
+
13
+ ## Properties
14
+
15
+ ### label
16
+
17
+ • **label**: `string`
18
+
19
+ #### Defined in
20
+
21
+ src/dataunit/metadata/UnitMetadata.ts:11
22
+
23
+ ___
24
+
25
+ ### links
26
+
27
+ • **links**: [`ChildLink`](ChildLink.md)[]
28
+
29
+ #### Defined in
30
+
31
+ src/dataunit/metadata/UnitMetadata.ts:13
32
+
33
+ ___
34
+
35
+ ### name
36
+
37
+ • **name**: `string`
38
+
39
+ #### Defined in
40
+
41
+ src/dataunit/metadata/UnitMetadata.ts:12