@sankhyalabs/core-docs 2.3.6 → 2.4.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.
@@ -2,6 +2,8 @@
2
2
 
3
3
  # Class: DataUnit
4
4
 
5
+ `DataUnit`: Atua como uma camada de abstração entre o back-end e a interface do usuário.
6
+
5
7
  ## Table of contents
6
8
 
7
9
  ### Constructors
@@ -100,7 +102,7 @@
100
102
 
101
103
  #### Defined in
102
104
 
103
- src/dataunit/DataUnit.ts:40
105
+ src/dataunit/DataUnit.ts:43
104
106
 
105
107
  ## Properties
106
108
 
@@ -110,7 +112,7 @@ src/dataunit/DataUnit.ts:40
110
112
 
111
113
  #### Defined in
112
114
 
113
- src/dataunit/DataUnit.ts:29
115
+ src/dataunit/DataUnit.ts:32
114
116
 
115
117
  ___
116
118
 
@@ -120,7 +122,7 @@ ___
120
122
 
121
123
  #### Defined in
122
124
 
123
- src/dataunit/DataUnit.ts:31
125
+ src/dataunit/DataUnit.ts:34
124
126
 
125
127
  ___
126
128
 
@@ -130,7 +132,7 @@ ___
130
132
 
131
133
  #### Defined in
132
134
 
133
- src/dataunit/DataUnit.ts:26
135
+ src/dataunit/DataUnit.ts:29
134
136
 
135
137
  ___
136
138
 
@@ -140,7 +142,7 @@ ___
140
142
 
141
143
  #### Defined in
142
144
 
143
- src/dataunit/DataUnit.ts:27
145
+ src/dataunit/DataUnit.ts:30
144
146
 
145
147
  ___
146
148
 
@@ -150,7 +152,7 @@ ___
150
152
 
151
153
  #### Defined in
152
154
 
153
- src/dataunit/DataUnit.ts:32
155
+ src/dataunit/DataUnit.ts:35
154
156
 
155
157
  ___
156
158
 
@@ -160,7 +162,7 @@ ___
160
162
 
161
163
  #### Defined in
162
164
 
163
- src/dataunit/DataUnit.ts:28
165
+ src/dataunit/DataUnit.ts:31
164
166
 
165
167
  ___
166
168
 
@@ -170,23 +172,23 @@ ___
170
172
 
171
173
  #### Defined in
172
174
 
173
- src/dataunit/DataUnit.ts:30
175
+ src/dataunit/DataUnit.ts:33
174
176
 
175
177
  ___
176
178
 
177
179
  ### dataLoader
178
180
 
179
- • `Optional` **dataLoader**: (`dataUnit`: [`DataUnit`](DataUnit.md), `request`: [`LoadDataRequest`](../interfaces/LoadDataRequest.md)) => `Promise`<[`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
181
+ • `Optional` **dataLoader**: (`DataUnit`: [`DataUnit`](DataUnit.md), `request`: [`LoadDataRequest`](../interfaces/LoadDataRequest.md)) => `Promise`<[`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
180
182
 
181
183
  #### Type declaration
182
184
 
183
- ▸ (`dataUnit`, `request`): `Promise`<[`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
185
+ ▸ (`DataUnit`, `request`): `Promise`<[`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
184
186
 
185
187
  ##### Parameters
186
188
 
187
189
  | Name | Type |
188
190
  | :------ | :------ |
189
- | `dataUnit` | [`DataUnit`](DataUnit.md) |
191
+ | `DataUnit` | [`DataUnit`](DataUnit.md) |
190
192
  | `request` | [`LoadDataRequest`](../interfaces/LoadDataRequest.md) |
191
193
 
192
194
  ##### Returns
@@ -195,23 +197,23 @@ ___
195
197
 
196
198
  #### Defined in
197
199
 
198
- src/dataunit/DataUnit.ts:35
200
+ src/dataunit/DataUnit.ts:38
199
201
 
200
202
  ___
201
203
 
202
204
  ### metadataLoader
203
205
 
204
- • `Optional` **metadataLoader**: (`dataUnit`: [`DataUnit`](DataUnit.md)) => `Promise`<[`UnitMetadata`](../interfaces/UnitMetadata.md)\>
206
+ • `Optional` **metadataLoader**: (`DataUnit`: [`DataUnit`](DataUnit.md)) => `Promise`<[`UnitMetadata`](../interfaces/UnitMetadata.md)\>
205
207
 
206
208
  #### Type declaration
207
209
 
208
- ▸ (`dataUnit`): `Promise`<[`UnitMetadata`](../interfaces/UnitMetadata.md)\>
210
+ ▸ (`DataUnit`): `Promise`<[`UnitMetadata`](../interfaces/UnitMetadata.md)\>
209
211
 
210
212
  ##### Parameters
211
213
 
212
214
  | Name | Type |
213
215
  | :------ | :------ |
214
- | `dataUnit` | [`DataUnit`](DataUnit.md) |
216
+ | `DataUnit` | [`DataUnit`](DataUnit.md) |
215
217
 
216
218
  ##### Returns
217
219
 
@@ -219,23 +221,23 @@ ___
219
221
 
220
222
  #### Defined in
221
223
 
222
- src/dataunit/DataUnit.ts:34
224
+ src/dataunit/DataUnit.ts:37
223
225
 
224
226
  ___
225
227
 
226
228
  ### recordLoader
227
229
 
228
- • `Optional` **recordLoader**: (`dataUnit`: [`DataUnit`](DataUnit.md), `recordIds`: `string`[]) => `Promise`<[`Record`](../interfaces/Record.md)[]\>
230
+ • `Optional` **recordLoader**: (`DataUnit`: [`DataUnit`](DataUnit.md), `recordIds`: `string`[]) => `Promise`<[`Record`](../interfaces/Record.md)[]\>
229
231
 
230
232
  #### Type declaration
231
233
 
232
- ▸ (`dataUnit`, `recordIds`): `Promise`<[`Record`](../interfaces/Record.md)[]\>
234
+ ▸ (`DataUnit`, `recordIds`): `Promise`<[`Record`](../interfaces/Record.md)[]\>
233
235
 
234
236
  ##### Parameters
235
237
 
236
238
  | Name | Type |
237
239
  | :------ | :------ |
238
- | `dataUnit` | [`DataUnit`](DataUnit.md) |
240
+ | `DataUnit` | [`DataUnit`](DataUnit.md) |
239
241
  | `recordIds` | `string`[] |
240
242
 
241
243
  ##### Returns
@@ -244,23 +246,23 @@ ___
244
246
 
245
247
  #### Defined in
246
248
 
247
- src/dataunit/DataUnit.ts:38
249
+ src/dataunit/DataUnit.ts:41
248
250
 
249
251
  ___
250
252
 
251
253
  ### removeLoader
252
254
 
253
- • `Optional` **removeLoader**: (`dataUnit`: [`DataUnit`](DataUnit.md), `recordIds`: `string`[]) => `Promise`<`string`[]\>
255
+ • `Optional` **removeLoader**: (`DataUnit`: [`DataUnit`](DataUnit.md), `recordIds`: `string`[]) => `Promise`<`string`[]\>
254
256
 
255
257
  #### Type declaration
256
258
 
257
- ▸ (`dataUnit`, `recordIds`): `Promise`<`string`[]\>
259
+ ▸ (`DataUnit`, `recordIds`): `Promise`<`string`[]\>
258
260
 
259
261
  ##### Parameters
260
262
 
261
263
  | Name | Type |
262
264
  | :------ | :------ |
263
- | `dataUnit` | [`DataUnit`](DataUnit.md) |
265
+ | `DataUnit` | [`DataUnit`](DataUnit.md) |
264
266
  | `recordIds` | `string`[] |
265
267
 
266
268
  ##### Returns
@@ -269,23 +271,23 @@ ___
269
271
 
270
272
  #### Defined in
271
273
 
272
- src/dataunit/DataUnit.ts:37
274
+ src/dataunit/DataUnit.ts:40
273
275
 
274
276
  ___
275
277
 
276
278
  ### saveLoader
277
279
 
278
- • `Optional` **saveLoader**: (`dataUnit`: [`DataUnit`](DataUnit.md), `changes`: [`Change`](Change.md)[]) => `Promise`<[`SavedRecord`](../interfaces/SavedRecord.md)[]\>
280
+ • `Optional` **saveLoader**: (`DataUnit`: [`DataUnit`](DataUnit.md), `changes`: [`Change`](Change.md)[]) => `Promise`<[`SavedRecord`](../interfaces/SavedRecord.md)[]\>
279
281
 
280
282
  #### Type declaration
281
283
 
282
- ▸ (`dataUnit`, `changes`): `Promise`<[`SavedRecord`](../interfaces/SavedRecord.md)[]\>
284
+ ▸ (`DataUnit`, `changes`): `Promise`<[`SavedRecord`](../interfaces/SavedRecord.md)[]\>
283
285
 
284
286
  ##### Parameters
285
287
 
286
288
  | Name | Type |
287
289
  | :------ | :------ |
288
- | `dataUnit` | [`DataUnit`](DataUnit.md) |
290
+ | `DataUnit` | [`DataUnit`](DataUnit.md) |
289
291
  | `changes` | [`Change`](Change.md)[] |
290
292
 
291
293
  ##### Returns
@@ -294,7 +296,7 @@ ___
294
296
 
295
297
  #### Defined in
296
298
 
297
- src/dataunit/DataUnit.ts:36
299
+ src/dataunit/DataUnit.ts:39
298
300
 
299
301
  ## Accessors
300
302
 
@@ -302,16 +304,20 @@ src/dataunit/DataUnit.ts:36
302
304
 
303
305
  • `get` **metadata**(): [`UnitMetadata`](../interfaces/UnitMetadata.md)
304
306
 
307
+ Obtém os metadados do DataUnit.
308
+
305
309
  #### Returns
306
310
 
307
311
  [`UnitMetadata`](../interfaces/UnitMetadata.md)
308
312
 
309
313
  #### Defined in
310
314
 
311
- src/dataunit/DataUnit.ts:294
315
+ src/dataunit/DataUnit.ts:488
312
316
 
313
317
  • `set` **metadata**(`md`): `void`
314
318
 
319
+ Define a propriedade metadata da instância da classe com um novo valor e chama o método dispatchAction para notificar os observers da aplicação sobre a mudança.
320
+
315
321
  #### Parameters
316
322
 
317
323
  | Name | Type |
@@ -324,7 +330,7 @@ src/dataunit/DataUnit.ts:294
324
330
 
325
331
  #### Defined in
326
332
 
327
- src/dataunit/DataUnit.ts:290
333
+ src/dataunit/DataUnit.ts:479
328
334
 
329
335
  ___
330
336
 
@@ -332,13 +338,17 @@ ___
332
338
 
333
339
  • `get` **name**(): `string`
334
340
 
341
+ Obtém o nome de identificação do DataUnit (geralmente em formato de URI - Uniform Resource Identifier).
342
+
335
343
  #### Returns
336
344
 
337
345
  `string`
338
346
 
347
+ - Nome de identificação do DataUnit.
348
+
339
349
  #### Defined in
340
350
 
341
- src/dataunit/DataUnit.ts:63
351
+ src/dataunit/DataUnit.ts:73
342
352
 
343
353
  ___
344
354
 
@@ -346,21 +356,27 @@ ___
346
356
 
347
357
  • `get` **pageSize**(): `number`
348
358
 
359
+ Obtém a quantidade de registros que está sendo exibido por página.
360
+
349
361
  #### Returns
350
362
 
351
363
  `number`
352
364
 
365
+ - Quantidade de registros exibidos por página.
366
+
353
367
  #### Defined in
354
368
 
355
- src/dataunit/DataUnit.ts:311
369
+ src/dataunit/DataUnit.ts:531
356
370
 
357
371
  • `set` **pageSize**(`size`): `void`
358
372
 
373
+ Define a quantidade de registros que será exibido por página.
374
+
359
375
  #### Parameters
360
376
 
361
- | Name | Type |
362
- | :------ | :------ |
363
- | `size` | `number` |
377
+ | Name | Type | Description |
378
+ | :------ | :------ | :------ |
379
+ | `size` | `number` | Quantidade de registros que será exibido por página. |
364
380
 
365
381
  #### Returns
366
382
 
@@ -368,7 +384,7 @@ src/dataunit/DataUnit.ts:311
368
384
 
369
385
  #### Defined in
370
386
 
371
- src/dataunit/DataUnit.ts:307
387
+ src/dataunit/DataUnit.ts:520
372
388
 
373
389
  ___
374
390
 
@@ -376,16 +392,22 @@ ___
376
392
 
377
393
  • `get` **records**(): [`Record`](../interfaces/Record.md)[]
378
394
 
395
+ Obtém todos os registros atuais.
396
+
379
397
  #### Returns
380
398
 
381
399
  [`Record`](../interfaces/Record.md)[]
382
400
 
401
+ - Todos os registros atuais.
402
+
383
403
  #### Defined in
384
404
 
385
- src/dataunit/DataUnit.ts:302
405
+ src/dataunit/DataUnit.ts:508
386
406
 
387
407
  • `set` **records**(`r`): `void`
388
408
 
409
+ Define a propriedade records da instância da classe com um novo valor e chama o método dispatchAction para notificar os observers da aplicação sobre a mudança.
410
+
389
411
  #### Parameters
390
412
 
391
413
  | Name | Type |
@@ -398,7 +420,7 @@ src/dataunit/DataUnit.ts:302
398
420
 
399
421
  #### Defined in
400
422
 
401
- src/dataunit/DataUnit.ts:298
423
+ src/dataunit/DataUnit.ts:497
402
424
 
403
425
  ___
404
426
 
@@ -406,11 +428,13 @@ ___
406
428
 
407
429
  • `set` **sortingProvider**(`provider`): `void`
408
430
 
431
+ Define a lógica de ordenação dos registros.
432
+
409
433
  #### Parameters
410
434
 
411
- | Name | Type |
412
- | :------ | :------ |
413
- | `provider` | [`SortingProvider`](../interfaces/SortingProvider.md) |
435
+ | Name | Type | Description |
436
+ | :------ | :------ | :------ |
437
+ | `provider` | [`SortingProvider`](../interfaces/SortingProvider.md) | Objeto usado para definir a propriedade sortingProvider da instância da classe. |
414
438
 
415
439
  #### Returns
416
440
 
@@ -418,7 +442,7 @@ ___
418
442
 
419
443
  #### Defined in
420
444
 
421
- src/dataunit/DataUnit.ts:286
445
+ src/dataunit/DataUnit.ts:470
422
446
 
423
447
  ## Methods
424
448
 
@@ -426,11 +450,13 @@ src/dataunit/DataUnit.ts:286
426
450
 
427
451
  ▸ **addFilterProvider**(`provider`): `void`
428
452
 
453
+ Adiciona um FilterProvider.
454
+
429
455
  #### Parameters
430
456
 
431
- | Name | Type |
432
- | :------ | :------ |
433
- | `provider` | `FilterProvider` |
457
+ | Name | Type | Description |
458
+ | :------ | :------ | :------ |
459
+ | `provider` | `FilterProvider` | FilterProvider que será adicionado. |
434
460
 
435
461
  #### Returns
436
462
 
@@ -438,7 +464,7 @@ src/dataunit/DataUnit.ts:286
438
464
 
439
465
  #### Defined in
440
466
 
441
- src/dataunit/DataUnit.ts:278
467
+ src/dataunit/DataUnit.ts:449
442
468
 
443
469
  ___
444
470
 
@@ -446,11 +472,13 @@ ___
446
472
 
447
473
  ▸ **addInterceptor**(`interceptor`): `void`
448
474
 
475
+ Adiciona um interceptor correspondente a uma ação do DataUnit para fazer um processamento customizado.
476
+
449
477
  #### Parameters
450
478
 
451
- | Name | Type |
452
- | :------ | :------ |
453
- | `interceptor` | [`DUActionInterceptor`](../interfaces/DUActionInterceptor.md) |
479
+ | Name | Type | Description |
480
+ | :------ | :------ | :------ |
481
+ | `interceptor` | [`DUActionInterceptor`](../interfaces/DUActionInterceptor.md) | Interceptor a ser adicionado. |
454
482
 
455
483
  #### Returns
456
484
 
@@ -458,7 +486,7 @@ ___
458
486
 
459
487
  #### Defined in
460
488
 
461
- src/dataunit/DataUnit.ts:270
489
+ src/dataunit/DataUnit.ts:427
462
490
 
463
491
  ___
464
492
 
@@ -466,11 +494,13 @@ ___
466
494
 
467
495
  ▸ **addRecord**(`executionCtx?`): `void`
468
496
 
497
+ Adiciona um novo registro.
498
+
469
499
  #### Parameters
470
500
 
471
- | Name | Type |
472
- | :------ | :------ |
473
- | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) |
501
+ | Name | Type | Description |
502
+ | :------ | :------ | :------ |
503
+ | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução da inserção do dado no DataUnit. |
474
504
 
475
505
  #### Returns
476
506
 
@@ -478,7 +508,7 @@ ___
478
508
 
479
509
  #### Defined in
480
510
 
481
- src/dataunit/DataUnit.ts:324
511
+ src/dataunit/DataUnit.ts:566
482
512
 
483
513
  ___
484
514
 
@@ -486,13 +516,17 @@ ___
486
516
 
487
517
  ▸ **canRedo**(): `boolean`
488
518
 
519
+ Retorna se a informação do estado futuro está salva, permitindo refazer a ação.
520
+
489
521
  #### Returns
490
522
 
491
523
  `boolean`
492
524
 
525
+ Verdadeiro se for possível refazer a ação.
526
+
493
527
  #### Defined in
494
528
 
495
- src/dataunit/DataUnit.ts:465
529
+ src/dataunit/DataUnit.ts:865
496
530
 
497
531
  ___
498
532
 
@@ -500,13 +534,17 @@ ___
500
534
 
501
535
  ▸ **canUndo**(): `boolean`
502
536
 
537
+ Retorna se a informação do estado anterior está salva, permitindo desfazer a ação.
538
+
503
539
  #### Returns
504
540
 
505
541
  `boolean`
506
542
 
543
+ Verdadeiro se for possível desfazer a ação.
544
+
507
545
  #### Defined in
508
546
 
509
- src/dataunit/DataUnit.ts:461
547
+ src/dataunit/DataUnit.ts:854
510
548
 
511
549
  ___
512
550
 
@@ -514,11 +552,13 @@ ___
514
552
 
515
553
  ▸ **cancelEdition**(`executionCtx?`): `void`
516
554
 
555
+ Cancela edição do registro atual.
556
+
517
557
  #### Parameters
518
558
 
519
- | Name | Type |
520
- | :------ | :------ |
521
- | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) |
559
+ | Name | Type | Description |
560
+ | :------ | :------ | :------ |
561
+ | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução do cancelamento da seleção dos registros. |
522
562
 
523
563
  #### Returns
524
564
 
@@ -526,7 +566,7 @@ ___
526
566
 
527
567
  #### Defined in
528
568
 
529
- src/dataunit/DataUnit.ts:433
569
+ src/dataunit/DataUnit.ts:791
530
570
 
531
571
  ___
532
572
 
@@ -534,11 +574,13 @@ ___
534
574
 
535
575
  ▸ **cancelWaitingChange**(`fieldName`): `void`
536
576
 
577
+ Cancela o início de uma alteração no campo.
578
+
537
579
  #### Parameters
538
580
 
539
- | Name | Type |
540
- | :------ | :------ |
541
- | `fieldName` | `string` |
581
+ | Name | Type | Description |
582
+ | :------ | :------ | :------ |
583
+ | `fieldName` | `string` | Identificador do campo. |
542
584
 
543
585
  #### Returns
544
586
 
@@ -546,7 +588,7 @@ ___
546
588
 
547
589
  #### Defined in
548
590
 
549
- src/dataunit/DataUnit.ts:357
591
+ src/dataunit/DataUnit.ts:648
550
592
 
551
593
  ___
552
594
 
@@ -554,11 +596,13 @@ ___
554
596
 
555
597
  ▸ **copySelected**(`executionCtx?`): `void`
556
598
 
599
+ Efetua a cópia do registro selecionado.
600
+
557
601
  #### Parameters
558
602
 
559
- | Name | Type |
560
- | :------ | :------ |
561
- | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) |
603
+ | Name | Type | Description |
604
+ | :------ | :------ | :------ |
605
+ | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução da cópia do dado do DataUnit. |
562
606
 
563
607
  #### Returns
564
608
 
@@ -566,7 +610,7 @@ ___
566
610
 
567
611
  #### Defined in
568
612
 
569
- src/dataunit/DataUnit.ts:328
613
+ src/dataunit/DataUnit.ts:577
570
614
 
571
615
  ___
572
616
 
@@ -574,21 +618,25 @@ ___
574
618
 
575
619
  ▸ `Private` **dispatchAction**(`actionType`, `payload?`, `executionCtx?`): `Promise`<`boolean`\>
576
620
 
621
+ Lança ação do DataUnit para que sejam processadas.
622
+
577
623
  #### Parameters
578
624
 
579
- | Name | Type |
580
- | :------ | :------ |
581
- | `actionType` | [`Action`](../enums/Action.md) |
582
- | `payload?` | `any` |
583
- | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) |
625
+ | Name | Type | Description |
626
+ | :------ | :------ | :------ |
627
+ | `actionType` | [`Action`](../enums/Action.md) | Tipo de ação que será executada. |
628
+ | `payload?` | `any` | Dados que serão processados na ação. |
629
+ | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução de lançar a ação que será executada. |
584
630
 
585
631
  #### Returns
586
632
 
587
633
  `Promise`<`boolean`\>
588
634
 
635
+ - Verdadeiro se ação iniciada.
636
+
589
637
  #### Defined in
590
638
 
591
- src/dataunit/DataUnit.ts:482
639
+ src/dataunit/DataUnit.ts:915
592
640
 
593
641
  ___
594
642
 
@@ -596,11 +644,13 @@ ___
596
644
 
597
645
  ▸ `Private` **doDispatchAction**(`action`): `void`
598
646
 
647
+ Processa as ações no DataUnit e notifica os observers.
648
+
599
649
  #### Parameters
600
650
 
601
- | Name | Type |
602
- | :------ | :------ |
603
- | `action` | [`DataUnitAction`](DataUnitAction.md) |
651
+ | Name | Type | Description |
652
+ | :------ | :------ | :------ |
653
+ | `action` | [`DataUnitAction`](DataUnitAction.md) | Ações em execução no DataUnit. |
604
654
 
605
655
  #### Returns
606
656
 
@@ -608,7 +658,7 @@ ___
608
658
 
609
659
  #### Defined in
610
660
 
611
- src/dataunit/DataUnit.ts:513
661
+ src/dataunit/DataUnit.ts:963
612
662
 
613
663
  ___
614
664
 
@@ -616,20 +666,24 @@ ___
616
666
 
617
667
  ▸ `Private` **executeLoadData**(`request`, `executionCtx?`): `Promise`<[`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
618
668
 
669
+ Executa o carregamento dos registros.
670
+
619
671
  #### Parameters
620
672
 
621
- | Name | Type |
622
- | :------ | :------ |
623
- | `request` | [`LoadDataRequest`](../interfaces/LoadDataRequest.md) |
624
- | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) |
673
+ | Name | Type | Description |
674
+ | :------ | :------ | :------ |
675
+ | `request` | [`LoadDataRequest`](../interfaces/LoadDataRequest.md) | Dados da requisição para carregamento dos registros. |
676
+ | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução do carregamento dos registros do DataUnit. |
625
677
 
626
678
  #### Returns
627
679
 
628
680
  `Promise`<[`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
629
681
 
682
+ - Registros do DataUnit.
683
+
630
684
  #### Defined in
631
685
 
632
- src/dataunit/DataUnit.ts:95
686
+ src/dataunit/DataUnit.ts:148
633
687
 
634
688
  ___
635
689
 
@@ -637,19 +691,23 @@ ___
637
691
 
638
692
  ▸ **getField**(`fieldName`): `undefined` \| [`FieldDescriptor`](../interfaces/FieldDescriptor.md)
639
693
 
694
+ Obtém metadados de um campo específico.
695
+
640
696
  #### Parameters
641
697
 
642
- | Name | Type |
643
- | :------ | :------ |
644
- | `fieldName` | `string` |
698
+ | Name | Type | Description |
699
+ | :------ | :------ | :------ |
700
+ | `fieldName` | `string` | Identificador do campo. |
645
701
 
646
702
  #### Returns
647
703
 
648
704
  `undefined` \| [`FieldDescriptor`](../interfaces/FieldDescriptor.md)
649
705
 
706
+ - Metadados do campo informado.
707
+
650
708
  #### Defined in
651
709
 
652
- src/dataunit/DataUnit.ts:320
710
+ src/dataunit/DataUnit.ts:555
653
711
 
654
712
  ___
655
713
 
@@ -657,19 +715,23 @@ ___
657
715
 
658
716
  ▸ **getFieldValue**(`fieldName`): `any`
659
717
 
718
+ Obtém valor do campo desejado.
719
+
660
720
  #### Parameters
661
721
 
662
- | Name | Type |
663
- | :------ | :------ |
664
- | `fieldName` | `string` |
722
+ | Name | Type | Description |
723
+ | :------ | :------ | :------ |
724
+ | `fieldName` | `string` | Identificador do campo a ser buscado. |
665
725
 
666
726
  #### Returns
667
727
 
668
728
  `any`
669
729
 
730
+ - Valor do campo.
731
+
670
732
  #### Defined in
671
733
 
672
- src/dataunit/DataUnit.ts:339
734
+ src/dataunit/DataUnit.ts:606
673
735
 
674
736
  ___
675
737
 
@@ -677,19 +739,23 @@ ___
677
739
 
678
740
  ▸ `Private` **getFielterProviderKey**(`provider`): `string`
679
741
 
742
+ Obtém chave única para identificação do FilterProvider.
743
+
680
744
  #### Parameters
681
745
 
682
- | Name | Type |
683
- | :------ | :------ |
684
- | `provider` | `FilterProvider` |
746
+ | Name | Type | Description |
747
+ | :------ | :------ | :------ |
748
+ | `provider` | `FilterProvider` | Interface FilterProvider na qual será retornada uma chave correspondente. |
685
749
 
686
750
  #### Returns
687
751
 
688
752
  `string`
689
753
 
754
+ - A chave do provider.
755
+
690
756
  #### Defined in
691
757
 
692
- src/dataunit/DataUnit.ts:88
758
+ src/dataunit/DataUnit.ts:131
693
759
 
694
760
  ___
695
761
 
@@ -697,13 +763,17 @@ ___
697
763
 
698
764
  ▸ `Private` **getFilters**(): `undefined` \| [`Filter`](../interfaces/Filter.md)[]
699
765
 
766
+ Obtém todos os filtros de dados.
767
+
700
768
  #### Returns
701
769
 
702
770
  `undefined` \| [`Filter`](../interfaces/Filter.md)[]
703
771
 
772
+ - Lista de filtros.
773
+
704
774
  #### Defined in
705
775
 
706
- src/dataunit/DataUnit.ts:73
776
+ src/dataunit/DataUnit.ts:100
707
777
 
708
778
  ___
709
779
 
@@ -711,13 +781,17 @@ ___
711
781
 
712
782
  ▸ **getModifiedRecords**(): [`Record`](../interfaces/Record.md)[]
713
783
 
784
+ Obtém os registros modificados e ainda não salvos no DataUnit.
785
+
714
786
  #### Returns
715
787
 
716
788
  [`Record`](../interfaces/Record.md)[]
717
789
 
790
+ - Lista dos registros em edição.
791
+
718
792
  #### Defined in
719
793
 
720
- src/dataunit/DataUnit.ts:315
794
+ src/dataunit/DataUnit.ts:542
721
795
 
722
796
  ___
723
797
 
@@ -725,13 +799,17 @@ ___
725
799
 
726
800
  ▸ **getPaginationInfo**(): `void` \| [`PaginationInfo`](../interfaces/PaginationInfo.md)
727
801
 
802
+ Obtém informações de paginação dos registros.
803
+
728
804
  #### Returns
729
805
 
730
806
  `void` \| [`PaginationInfo`](../interfaces/PaginationInfo.md)
731
807
 
808
+ - Informações da paginação de registros.
809
+
732
810
  #### Defined in
733
811
 
734
- src/dataunit/DataUnit.ts:282
812
+ src/dataunit/DataUnit.ts:459
735
813
 
736
814
  ___
737
815
 
@@ -739,13 +817,17 @@ ___
739
817
 
740
818
  ▸ **getSelectedRecords**(): `undefined` \| [`Record`](../interfaces/Record.md)[]
741
819
 
820
+ Obtém todos os registros selecionados.
821
+
742
822
  #### Returns
743
823
 
744
824
  `undefined` \| [`Record`](../interfaces/Record.md)[]
745
825
 
826
+ - Lista de registros selecionados.
827
+
746
828
  #### Defined in
747
829
 
748
- src/dataunit/DataUnit.ts:385
830
+ src/dataunit/DataUnit.ts:721
749
831
 
750
832
  ___
751
833
 
@@ -753,13 +835,17 @@ ___
753
835
 
754
836
  ▸ **getSelection**(): `string`[]
755
837
 
838
+ Obtém registros selecionados.
839
+
756
840
  #### Returns
757
841
 
758
842
  `string`[]
759
843
 
844
+ - Registros selecionados.
845
+
760
846
  #### Defined in
761
847
 
762
- src/dataunit/DataUnit.ts:361
848
+ src/dataunit/DataUnit.ts:659
763
849
 
764
850
  ___
765
851
 
@@ -767,13 +853,17 @@ ___
767
853
 
768
854
  ▸ `Private` **getSort**(): `undefined` \| [`Sort`](../interfaces/Sort.md)[]
769
855
 
856
+ Obtém a estrutura de ordenação das colunas dos dados.
857
+
770
858
  #### Returns
771
859
 
772
860
  `undefined` \| [`Sort`](../interfaces/Sort.md)[]
773
861
 
862
+ - Lista dos ordenáveis por prioridade.
863
+
774
864
  #### Defined in
775
865
 
776
- src/dataunit/DataUnit.ts:84
866
+ src/dataunit/DataUnit.ts:118
777
867
 
778
868
  ___
779
869
 
@@ -781,20 +871,24 @@ ___
781
871
 
782
872
  ▸ **gotoPage**(`page`, `executionCtx?`): `Promise`<`void` \| [`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
783
873
 
874
+ Alterna entre os registros por número de página.
875
+
784
876
  #### Parameters
785
877
 
786
- | Name | Type |
787
- | :------ | :------ |
788
- | `page` | `number` |
789
- | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) |
878
+ | Name | Type | Description |
879
+ | :------ | :------ | :------ |
880
+ | `page` | `number` | Número da página desejada. |
881
+ | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução do carregamento dos registros do DataUnit. |
790
882
 
791
883
  #### Returns
792
884
 
793
885
  `Promise`<`void` \| [`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
794
886
 
887
+ - Registros da página desejada.
888
+
795
889
  #### Defined in
796
890
 
797
- src/dataunit/DataUnit.ts:148
891
+ src/dataunit/DataUnit.ts:230
798
892
 
799
893
  ___
800
894
 
@@ -802,13 +896,17 @@ ___
802
896
 
803
897
  ▸ **hasDirtyRecords**(): `boolean`
804
898
 
899
+ Retorna se existe algum registro em modo de edição.
900
+
805
901
  #### Returns
806
902
 
807
903
  `boolean`
808
904
 
905
+ Verdadeiro se existir alterações de registros pendentes.
906
+
809
907
  #### Defined in
810
908
 
811
- src/dataunit/DataUnit.ts:441
909
+ src/dataunit/DataUnit.ts:813
812
910
 
813
911
  ___
814
912
 
@@ -816,13 +914,17 @@ ___
816
914
 
817
915
  ▸ **hasNext**(): `boolean`
818
916
 
917
+ Retorna se existir uma pagina seguinte a atual na paginação.
918
+
819
919
  #### Returns
820
920
 
821
921
  `boolean`
822
922
 
923
+ Verdadeiro se existir uma próxima página.
924
+
823
925
  #### Defined in
824
926
 
825
- src/dataunit/DataUnit.ts:445
927
+ src/dataunit/DataUnit.ts:824
826
928
 
827
929
  ___
828
930
 
@@ -830,13 +932,17 @@ ___
830
932
 
831
933
  ▸ **hasPrevious**(): `boolean`
832
934
 
935
+ Retorna se existe uma página anterior a atual na paginação.
936
+
833
937
  #### Returns
834
938
 
835
939
  `boolean`
836
940
 
941
+ Verdadeiro se existir uma página anterior.
942
+
837
943
  #### Defined in
838
944
 
839
- src/dataunit/DataUnit.ts:453
945
+ src/dataunit/DataUnit.ts:839
840
946
 
841
947
  ___
842
948
 
@@ -844,20 +950,24 @@ ___
844
950
 
845
951
  ▸ `Private` **intercept**(`action`, `interceptors`): `Promise`<[`DataUnitAction`](DataUnitAction.md)\>
846
952
 
953
+ Notifica os interceptors de que uma ação foi executada, para que cada interceptor possa fazer sua respectiva tratativa dos dados.
954
+
847
955
  #### Parameters
848
956
 
849
- | Name | Type |
850
- | :------ | :------ |
851
- | `action` | [`DataUnitAction`](DataUnitAction.md) |
852
- | `interceptors` | `IterableIterator`<[`DUActionInterceptor`](../interfaces/DUActionInterceptor.md)\> |
957
+ | Name | Type | Description |
958
+ | :------ | :------ | :------ |
959
+ | `action` | [`DataUnitAction`](DataUnitAction.md) | Ação que foi executada. |
960
+ | `interceptors` | `IterableIterator`<[`DUActionInterceptor`](../interfaces/DUActionInterceptor.md)\> | Interceptors que serão notificados. |
853
961
 
854
962
  #### Returns
855
963
 
856
964
  `Promise`<[`DataUnitAction`](DataUnitAction.md)\>
857
965
 
966
+ - Ação executada no DataUnit.
967
+
858
968
  #### Defined in
859
969
 
860
- src/dataunit/DataUnit.ts:503
970
+ src/dataunit/DataUnit.ts:946
861
971
 
862
972
  ___
863
973
 
@@ -865,13 +975,17 @@ ___
865
975
 
866
976
  ▸ **isDirty**(): `boolean`
867
977
 
978
+ Retorna se existe algum tipo de alteração pendente.
979
+
868
980
  #### Returns
869
981
 
870
982
  `boolean`
871
983
 
984
+ Verdadeiro se existir alterações pendentes.
985
+
872
986
  #### Defined in
873
987
 
874
- src/dataunit/DataUnit.ts:437
988
+ src/dataunit/DataUnit.ts:802
875
989
 
876
990
  ___
877
991
 
@@ -879,20 +993,24 @@ ___
879
993
 
880
994
  ▸ **loadData**(`quickFilter?`, `executionCtx?`): `Promise`<[`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
881
995
 
996
+ Carrega os registros do DataUnit.
997
+
882
998
  #### Parameters
883
999
 
884
- | Name | Type |
885
- | :------ | :------ |
886
- | `quickFilter?` | [`QuickFilter`](../interfaces/QuickFilter.md) |
887
- | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) |
1000
+ | Name | Type | Description |
1001
+ | :------ | :------ | :------ |
1002
+ | `quickFilter?` | [`QuickFilter`](../interfaces/QuickFilter.md) | Filtros a serem aplicados. |
1003
+ | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução do carregamento dos registros. |
888
1004
 
889
1005
  #### Returns
890
1006
 
891
1007
  `Promise`<[`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
892
1008
 
1009
+ - Registros requisitados.
1010
+
893
1011
  #### Defined in
894
1012
 
895
- src/dataunit/DataUnit.ts:132
1013
+ src/dataunit/DataUnit.ts:204
896
1014
 
897
1015
  ___
898
1016
 
@@ -900,19 +1018,23 @@ ___
900
1018
 
901
1019
  ▸ **loadMetadata**(`executionCtx?`): `Promise`<`void` \| [`UnitMetadata`](../interfaces/UnitMetadata.md)\>
902
1020
 
1021
+ Carrega os metadados do DataUnit.
1022
+
903
1023
  #### Parameters
904
1024
 
905
- | Name | Type |
906
- | :------ | :------ |
907
- | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) |
1025
+ | Name | Type | Description |
1026
+ | :------ | :------ | :------ |
1027
+ | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução do carregamento dos metadados do DataUnit. |
908
1028
 
909
1029
  #### Returns
910
1030
 
911
1031
  `Promise`<`void` \| [`UnitMetadata`](../interfaces/UnitMetadata.md)\>
912
1032
 
1033
+ - Metadados carregados.
1034
+
913
1035
  #### Defined in
914
1036
 
915
- src/dataunit/DataUnit.ts:114
1037
+ src/dataunit/DataUnit.ts:176
916
1038
 
917
1039
  ___
918
1040
 
@@ -920,19 +1042,23 @@ ___
920
1042
 
921
1043
  ▸ **nextPage**(`executionCtx?`): `Promise`<`void` \| [`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
922
1044
 
1045
+ Vai para os registros da página seguinte.
1046
+
923
1047
  #### Parameters
924
1048
 
925
- | Name | Type |
926
- | :------ | :------ |
927
- | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) |
1049
+ | Name | Type | Description |
1050
+ | :------ | :------ | :------ |
1051
+ | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução do carregamento dos registros do DataUnit. |
928
1052
 
929
1053
  #### Returns
930
1054
 
931
1055
  `Promise`<`void` \| [`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
932
1056
 
1057
+ - Registros da página seguinte.
1058
+
933
1059
  #### Defined in
934
1060
 
935
- src/dataunit/DataUnit.ts:168
1061
+ src/dataunit/DataUnit.ts:259
936
1062
 
937
1063
  ___
938
1064
 
@@ -940,11 +1066,13 @@ ___
940
1066
 
941
1067
  ▸ **nextRecord**(`executionCtx?`): `void`
942
1068
 
1069
+ Seleciona o próximo registro.
1070
+
943
1071
  #### Parameters
944
1072
 
945
- | Name | Type |
946
- | :------ | :------ |
947
- | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) |
1073
+ | Name | Type | Description |
1074
+ | :------ | :------ | :------ |
1075
+ | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução da seleção do registro do DataUnit. |
948
1076
 
949
1077
  #### Returns
950
1078
 
@@ -952,7 +1080,7 @@ ___
952
1080
 
953
1081
  #### Defined in
954
1082
 
955
- src/dataunit/DataUnit.ts:393
1083
+ src/dataunit/DataUnit.ts:737
956
1084
 
957
1085
  ___
958
1086
 
@@ -960,19 +1088,23 @@ ___
960
1088
 
961
1089
  ▸ **previousPage**(`executionCtx?`): `Promise`<`void` \| [`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
962
1090
 
1091
+ Vai para os registros da página anterior.
1092
+
963
1093
  #### Parameters
964
1094
 
965
- | Name | Type |
966
- | :------ | :------ |
967
- | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) |
1095
+ | Name | Type | Description |
1096
+ | :------ | :------ | :------ |
1097
+ | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução do carregamento dos registros do DataUnit. |
968
1098
 
969
1099
  #### Returns
970
1100
 
971
1101
  `Promise`<`void` \| [`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
972
1102
 
1103
+ - Registros da página anterior.
1104
+
973
1105
  #### Defined in
974
1106
 
975
- src/dataunit/DataUnit.ts:172
1107
+ src/dataunit/DataUnit.ts:272
976
1108
 
977
1109
  ___
978
1110
 
@@ -980,11 +1112,13 @@ ___
980
1112
 
981
1113
  ▸ **previousRecord**(`executionCtx?`): `void`
982
1114
 
1115
+ Seleciona o registro anterior.
1116
+
983
1117
  #### Parameters
984
1118
 
985
- | Name | Type |
986
- | :------ | :------ |
987
- | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) |
1119
+ | Name | Type | Description |
1120
+ | :------ | :------ | :------ |
1121
+ | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução da seleção do registro do DataUnit. |
988
1122
 
989
1123
  #### Returns
990
1124
 
@@ -992,7 +1126,7 @@ ___
992
1126
 
993
1127
  #### Defined in
994
1128
 
995
- src/dataunit/DataUnit.ts:413
1129
+ src/dataunit/DataUnit.ts:764
996
1130
 
997
1131
  ___
998
1132
 
@@ -1000,11 +1134,13 @@ ___
1000
1134
 
1001
1135
  ▸ **redo**(`executionCtx?`): `void`
1002
1136
 
1137
+ Refaz a última ação.
1138
+
1003
1139
  #### Parameters
1004
1140
 
1005
- | Name | Type |
1006
- | :------ | :------ |
1007
- | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) |
1141
+ | Name | Type | Description |
1142
+ | :------ | :------ | :------ |
1143
+ | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução de refazer a última ação. |
1008
1144
 
1009
1145
  #### Returns
1010
1146
 
@@ -1012,7 +1148,7 @@ ___
1012
1148
 
1013
1149
  #### Defined in
1014
1150
 
1015
- src/dataunit/DataUnit.ts:473
1151
+ src/dataunit/DataUnit.ts:888
1016
1152
 
1017
1153
  ___
1018
1154
 
@@ -1020,13 +1156,17 @@ ___
1020
1156
 
1021
1157
  ▸ **reloadCurrentRecord**(): `Promise`<[`Record`](../interfaces/Record.md)[]\>
1022
1158
 
1159
+ Recarrega registro selecionado com dados atualizados do servidor.
1160
+
1023
1161
  #### Returns
1024
1162
 
1025
1163
  `Promise`<[`Record`](../interfaces/Record.md)[]\>
1026
1164
 
1165
+ - Dados atualizados do registro selecionado.
1166
+
1027
1167
  #### Defined in
1028
1168
 
1029
- src/dataunit/DataUnit.ts:536
1169
+ src/dataunit/DataUnit.ts:1008
1030
1170
 
1031
1171
  ___
1032
1172
 
@@ -1034,11 +1174,13 @@ ___
1034
1174
 
1035
1175
  ▸ **removeInterceptor**(`interceptor`): `void`
1036
1176
 
1177
+ Remove um interceptor da lista de interceptors.
1178
+
1037
1179
  #### Parameters
1038
1180
 
1039
- | Name | Type |
1040
- | :------ | :------ |
1041
- | `interceptor` | [`DUActionInterceptor`](../interfaces/DUActionInterceptor.md) |
1181
+ | Name | Type | Description |
1182
+ | :------ | :------ | :------ |
1183
+ | `interceptor` | [`DUActionInterceptor`](../interfaces/DUActionInterceptor.md) | Interceptor a ser removido. |
1042
1184
 
1043
1185
  #### Returns
1044
1186
 
@@ -1046,7 +1188,7 @@ ___
1046
1188
 
1047
1189
  #### Defined in
1048
1190
 
1049
- src/dataunit/DataUnit.ts:274
1191
+ src/dataunit/DataUnit.ts:438
1050
1192
 
1051
1193
  ___
1052
1194
 
@@ -1054,22 +1196,26 @@ ___
1054
1196
 
1055
1197
  ▸ **removeRecords**(`recordIds`, `cachedRecords`, `buffered?`, `executionCtx?`): `Promise`<`string`[]\>
1056
1198
 
1199
+ Efetua requisição para remoção dos registros.
1200
+
1057
1201
  #### Parameters
1058
1202
 
1059
- | Name | Type | Default value |
1060
- | :------ | :------ | :------ |
1061
- | `recordIds` | `string`[] | `undefined` |
1062
- | `cachedRecords` | [`Record`](../interfaces/Record.md)[] | `undefined` |
1063
- | `buffered` | `boolean` | `false` |
1064
- | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | `undefined` |
1203
+ | Name | Type | Default value | Description |
1204
+ | :------ | :------ | :------ | :------ |
1205
+ | `recordIds` | `string`[] | `undefined` | Lista de IDs dos registros que serão removidos. |
1206
+ | `cachedRecords` | [`Record`](../interfaces/Record.md)[] | `undefined` | Dados dos registros que serão removidos. |
1207
+ | `buffered` | `boolean` | `false` | Se será utilizado buffer na solicitação. |
1208
+ | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | `undefined` | Contexto de execução da remoção do registro do DataUnit. |
1065
1209
 
1066
1210
  #### Returns
1067
1211
 
1068
1212
  `Promise`<`string`[]\>
1069
1213
 
1214
+ - ID's dos registros removidos.
1215
+
1070
1216
  #### Defined in
1071
1217
 
1072
- src/dataunit/DataUnit.ts:221
1218
+ src/dataunit/DataUnit.ts:351
1073
1219
 
1074
1220
  ___
1075
1221
 
@@ -1077,19 +1223,23 @@ ___
1077
1223
 
1078
1224
  ▸ **removeSelectedRecords**(`buffered?`): `Promise`<`string`[]\>
1079
1225
 
1226
+ Remove o registro selecionado.
1227
+
1080
1228
  #### Parameters
1081
1229
 
1082
- | Name | Type | Default value |
1083
- | :------ | :------ | :------ |
1084
- | `buffered` | `boolean` | `false` |
1230
+ | Name | Type | Default value | Description |
1231
+ | :------ | :------ | :------ | :------ |
1232
+ | `buffered` | `boolean` | `false` | Se será utilizado buffer na solicitação. |
1085
1233
 
1086
1234
  #### Returns
1087
1235
 
1088
1236
  `Promise`<`string`[]\>
1089
1237
 
1238
+ - ID's dos registros removidos.
1239
+
1090
1240
  #### Defined in
1091
1241
 
1092
- src/dataunit/DataUnit.ts:212
1242
+ src/dataunit/DataUnit.ts:330
1093
1243
 
1094
1244
  ___
1095
1245
 
@@ -1097,19 +1247,23 @@ ___
1097
1247
 
1098
1248
  ▸ **saveData**(`executionCtx?`): `Promise`<`void`\>
1099
1249
 
1250
+ Salva o estado do registro do DataUnit.
1251
+
1100
1252
  #### Parameters
1101
1253
 
1102
- | Name | Type |
1103
- | :------ | :------ |
1104
- | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) |
1254
+ | Name | Type | Description |
1255
+ | :------ | :------ | :------ |
1256
+ | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução da persistencia do registro do DataUnit. |
1105
1257
 
1106
1258
  #### Returns
1107
1259
 
1108
1260
  `Promise`<`void`\>
1109
1261
 
1262
+ - Resposta da solicitação.
1263
+
1110
1264
  #### Defined in
1111
1265
 
1112
- src/dataunit/DataUnit.ts:176
1266
+ src/dataunit/DataUnit.ts:285
1113
1267
 
1114
1268
  ___
1115
1269
 
@@ -1117,11 +1271,13 @@ ___
1117
1271
 
1118
1272
  ▸ **selectFirst**(`executionCtx?`): `void`
1119
1273
 
1274
+ Seleciona o primeiro registro.
1275
+
1120
1276
  #### Parameters
1121
1277
 
1122
- | Name | Type |
1123
- | :------ | :------ |
1124
- | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) |
1278
+ | Name | Type | Description |
1279
+ | :------ | :------ | :------ |
1280
+ | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução da seleção do registro do DataUnit. |
1125
1281
 
1126
1282
  #### Returns
1127
1283
 
@@ -1129,7 +1285,7 @@ ___
1129
1285
 
1130
1286
  #### Defined in
1131
1287
 
1132
- src/dataunit/DataUnit.ts:369
1288
+ src/dataunit/DataUnit.ts:682
1133
1289
 
1134
1290
  ___
1135
1291
 
@@ -1137,11 +1293,13 @@ ___
1137
1293
 
1138
1294
  ▸ **selectLast**(`executionCtx?`): `void`
1139
1295
 
1296
+ Seleciona o último registro.
1297
+
1140
1298
  #### Parameters
1141
1299
 
1142
- | Name | Type |
1143
- | :------ | :------ |
1144
- | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) |
1300
+ | Name | Type | Description |
1301
+ | :------ | :------ | :------ |
1302
+ | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução da seleção do registro do DataUnit. |
1145
1303
 
1146
1304
  #### Returns
1147
1305
 
@@ -1149,7 +1307,7 @@ ___
1149
1307
 
1150
1308
  #### Defined in
1151
1309
 
1152
- src/dataunit/DataUnit.ts:375
1310
+ src/dataunit/DataUnit.ts:695
1153
1311
 
1154
1312
  ___
1155
1313
 
@@ -1157,13 +1315,15 @@ ___
1157
1315
 
1158
1316
  ▸ **setFieldValue**(`fieldName`, `newValue`, `records?`): `void`
1159
1317
 
1318
+ Insere valor no campo desejado.
1319
+
1160
1320
  #### Parameters
1161
1321
 
1162
- | Name | Type |
1163
- | :------ | :------ |
1164
- | `fieldName` | `string` |
1165
- | `newValue` | `any` |
1166
- | `records?` | `string`[] |
1322
+ | Name | Type | Description |
1323
+ | :------ | :------ | :------ |
1324
+ | `fieldName` | `string` | Identificador do campo a ser modificado. |
1325
+ | `newValue` | `any` | Valor a ser inserido no campo. |
1326
+ | `records?` | `string`[] | Indica quais registros foram afetados pela alteração no valor do campo. |
1167
1327
 
1168
1328
  #### Returns
1169
1329
 
@@ -1171,7 +1331,7 @@ ___
1171
1331
 
1172
1332
  #### Defined in
1173
1333
 
1174
- src/dataunit/DataUnit.ts:343
1334
+ src/dataunit/DataUnit.ts:619
1175
1335
 
1176
1336
  ___
1177
1337
 
@@ -1179,12 +1339,14 @@ ___
1179
1339
 
1180
1340
  ▸ **setSelection**(`selection`, `executionCtx?`): `void`
1181
1341
 
1342
+ Seleciona múltiplos registros por ID.
1343
+
1182
1344
  #### Parameters
1183
1345
 
1184
- | Name | Type |
1185
- | :------ | :------ |
1186
- | `selection` | `string`[] |
1187
- | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) |
1346
+ | Name | Type | Description |
1347
+ | :------ | :------ | :------ |
1348
+ | `selection` | `string`[] | IDs para selecionar. |
1349
+ | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução da seleção dos registros do DataUnit. |
1188
1350
 
1189
1351
  #### Returns
1190
1352
 
@@ -1192,7 +1354,7 @@ ___
1192
1354
 
1193
1355
  #### Defined in
1194
1356
 
1195
- src/dataunit/DataUnit.ts:365
1357
+ src/dataunit/DataUnit.ts:671
1196
1358
 
1197
1359
  ___
1198
1360
 
@@ -1200,12 +1362,14 @@ ___
1200
1362
 
1201
1363
  ▸ **setSelectionByIndex**(`selection`, `executionCtx?`): `void`
1202
1364
 
1365
+ Seleciona múltiplos registros por índice.
1366
+
1203
1367
  #### Parameters
1204
1368
 
1205
- | Name | Type |
1206
- | :------ | :------ |
1207
- | `selection` | `number`[] |
1208
- | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) |
1369
+ | Name | Type | Description |
1370
+ | :------ | :------ | :------ |
1371
+ | `selection` | `number`[] | Índices desejados para a seleção. |
1372
+ | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução da seleção do registro do DataUnit. |
1209
1373
 
1210
1374
  #### Returns
1211
1375
 
@@ -1213,7 +1377,7 @@ ___
1213
1377
 
1214
1378
  #### Defined in
1215
1379
 
1216
- src/dataunit/DataUnit.ts:381
1380
+ src/dataunit/DataUnit.ts:710
1217
1381
 
1218
1382
  ___
1219
1383
 
@@ -1221,12 +1385,14 @@ ___
1221
1385
 
1222
1386
  ▸ **startChange**(`fieldName`, `waitingChange`): `void`
1223
1387
 
1388
+ Inicia alteração no campo.
1389
+
1224
1390
  #### Parameters
1225
1391
 
1226
- | Name | Type |
1227
- | :------ | :------ |
1228
- | `fieldName` | `string` |
1229
- | `waitingChange` | [`WaitingChange`](../interfaces/WaitingChange.md) |
1392
+ | Name | Type | Description |
1393
+ | :------ | :------ | :------ |
1394
+ | `fieldName` | `string` | Identificador do campo a ser modificado. |
1395
+ | `waitingChange` | [`WaitingChange`](../interfaces/WaitingChange.md) | Informa que uma mudança irá iniciar. |
1230
1396
 
1231
1397
  #### Returns
1232
1398
 
@@ -1234,7 +1400,7 @@ ___
1234
1400
 
1235
1401
  #### Defined in
1236
1402
 
1237
- src/dataunit/DataUnit.ts:353
1403
+ src/dataunit/DataUnit.ts:637
1238
1404
 
1239
1405
  ___
1240
1406
 
@@ -1242,11 +1408,14 @@ ___
1242
1408
 
1243
1409
  ▸ **subscribe**(`observer`): `void`
1244
1410
 
1411
+ Adiciona um novo observer no DataUnit.
1412
+ Ela vai ser chamada sempre que uma ação for despachada (dispatchAction()).
1413
+
1245
1414
  #### Parameters
1246
1415
 
1247
- | Name | Type |
1248
- | :------ | :------ |
1249
- | `observer` | (`action`: [`DataUnitAction`](DataUnitAction.md)) => `void` |
1416
+ | Name | Type | Description |
1417
+ | :------ | :------ | :------ |
1418
+ | `observer` | (`action`: [`DataUnitAction`](DataUnitAction.md)) => `void` | Função que recebe como parâmetro as ações que serão monitoradas. |
1250
1419
 
1251
1420
  #### Returns
1252
1421
 
@@ -1254,7 +1423,7 @@ ___
1254
1423
 
1255
1424
  #### Defined in
1256
1425
 
1257
- src/dataunit/DataUnit.ts:528
1426
+ src/dataunit/DataUnit.ts:986
1258
1427
 
1259
1428
  ___
1260
1429
 
@@ -1262,13 +1431,17 @@ ___
1262
1431
 
1263
1432
  ▸ **toString**(): `string`
1264
1433
 
1434
+ Obtém a representação textual do DataUnit, nesse caso, o nome do DataUnit.
1435
+
1265
1436
  #### Returns
1266
1437
 
1267
1438
  `string`
1268
1439
 
1440
+ - Valor contido na propriedade name.
1441
+
1269
1442
  #### Defined in
1270
1443
 
1271
- src/dataunit/DataUnit.ts:477
1444
+ src/dataunit/DataUnit.ts:899
1272
1445
 
1273
1446
  ___
1274
1447
 
@@ -1276,11 +1449,13 @@ ___
1276
1449
 
1277
1450
  ▸ **undo**(`executionCtx?`): `void`
1278
1451
 
1452
+ Desfaz a última ação.
1453
+
1279
1454
  #### Parameters
1280
1455
 
1281
- | Name | Type |
1282
- | :------ | :------ |
1283
- | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) |
1456
+ | Name | Type | Description |
1457
+ | :------ | :------ | :------ |
1458
+ | `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução de desfazer a última ação. |
1284
1459
 
1285
1460
  #### Returns
1286
1461
 
@@ -1288,7 +1463,7 @@ ___
1288
1463
 
1289
1464
  #### Defined in
1290
1465
 
1291
- src/dataunit/DataUnit.ts:469
1466
+ src/dataunit/DataUnit.ts:877
1292
1467
 
1293
1468
  ___
1294
1469
 
@@ -1296,11 +1471,13 @@ ___
1296
1471
 
1297
1472
  ▸ **unsubscribe**(`observer`): `void`
1298
1473
 
1474
+ Remove um observer existente.
1475
+
1299
1476
  #### Parameters
1300
1477
 
1301
- | Name | Type |
1302
- | :------ | :------ |
1303
- | `observer` | `Function` |
1478
+ | Name | Type | Description |
1479
+ | :------ | :------ | :------ |
1480
+ | `observer` | `Function` | Observer que se deseja remover. |
1304
1481
 
1305
1482
  #### Returns
1306
1483
 
@@ -1308,7 +1485,7 @@ ___
1308
1485
 
1309
1486
  #### Defined in
1310
1487
 
1311
- src/dataunit/DataUnit.ts:532
1488
+ src/dataunit/DataUnit.ts:997
1312
1489
 
1313
1490
  ___
1314
1491
 
@@ -1316,20 +1493,24 @@ ___
1316
1493
 
1317
1494
  ▸ `Private` **validateAndTypeValue**(`fieldName`, `newValue`): `any`
1318
1495
 
1496
+ Obtém o valor convertido de acordo com o tipo do campo.
1497
+
1319
1498
  #### Parameters
1320
1499
 
1321
- | Name | Type |
1322
- | :------ | :------ |
1323
- | `fieldName` | `string` |
1324
- | `newValue` | `any` |
1500
+ | Name | Type | Description |
1501
+ | :------ | :------ | :------ |
1502
+ | `fieldName` | `string` | Identificador do campo. |
1503
+ | `newValue` | `any` | Novo valor que será atribuído ao campo pós validação. |
1325
1504
 
1326
1505
  #### Returns
1327
1506
 
1328
1507
  `any`
1329
1508
 
1509
+ - Novo valor convertido em um tipo valido.
1510
+
1330
1511
  #### Defined in
1331
1512
 
1332
- src/dataunit/DataUnit.ts:68
1513
+ src/dataunit/DataUnit.ts:87
1333
1514
 
1334
1515
  ___
1335
1516
 
@@ -1337,20 +1518,24 @@ ___
1337
1518
 
1338
1519
  ▸ **valueFromString**(`fieldName`, `value`): `any`
1339
1520
 
1521
+ Obtém o valor do campo em seu formato/tipo correto a partir de uma string.
1522
+
1340
1523
  #### Parameters
1341
1524
 
1342
- | Name | Type |
1343
- | :------ | :------ |
1344
- | `fieldName` | `string` |
1345
- | `value` | `string` |
1525
+ | Name | Type | Description |
1526
+ | :------ | :------ | :------ |
1527
+ | `fieldName` | `string` | Nome do campo que terá o tipo identificado para conversão. |
1528
+ | `value` | `string` | Texto que será convertido de acordo com o tipo identificado no campo. |
1346
1529
 
1347
1530
  #### Returns
1348
1531
 
1349
1532
  `any`
1350
1533
 
1534
+ - Valor convertido ou ele mesmo.
1535
+
1351
1536
  #### Defined in
1352
1537
 
1353
- src/dataunit/DataUnit.ts:260
1538
+ src/dataunit/DataUnit.ts:400
1354
1539
 
1355
1540
  ___
1356
1541
 
@@ -1358,20 +1543,24 @@ ___
1358
1543
 
1359
1544
  ▸ **valueToString**(`fieldName`, `value`): `string`
1360
1545
 
1546
+ Converte o valor informado para texto de acordo com o tipo do campo informado.
1547
+
1361
1548
  #### Parameters
1362
1549
 
1363
- | Name | Type |
1364
- | :------ | :------ |
1365
- | `fieldName` | `string` |
1366
- | `value` | `any` |
1550
+ | Name | Type | Description |
1551
+ | :------ | :------ | :------ |
1552
+ | `fieldName` | `string` | Nome do campo utilizado para buscar o tipo de dado com o padrão de conversão para string. |
1553
+ | `value` | `any` | Valor a ser convertido. |
1367
1554
 
1368
1555
  #### Returns
1369
1556
 
1370
1557
  `string`
1371
1558
 
1559
+ - Valor informado convertido.
1560
+
1372
1561
  #### Defined in
1373
1562
 
1374
- src/dataunit/DataUnit.ts:265
1563
+ src/dataunit/DataUnit.ts:415
1375
1564
 
1376
1565
  ___
1377
1566
 
@@ -1379,16 +1568,20 @@ ___
1379
1568
 
1380
1569
  ▸ **waitingForChange**(`fieldName`): `boolean`
1381
1570
 
1571
+ Retorna se a alteração no campo já foi concluída ou se ainda está incompleta.
1572
+
1382
1573
  #### Parameters
1383
1574
 
1384
- | Name | Type |
1385
- | :------ | :------ |
1386
- | `fieldName` | `string` |
1575
+ | Name | Type | Description |
1576
+ | :------ | :------ | :------ |
1577
+ | `fieldName` | `string` | Identificador do campo a ser verificado. |
1387
1578
 
1388
1579
  #### Returns
1389
1580
 
1390
1581
  `boolean`
1391
1582
 
1583
+ - Verdadeiro se ainda está pendente.
1584
+
1392
1585
  #### Defined in
1393
1586
 
1394
- src/dataunit/DataUnit.ts:335
1587
+ src/dataunit/DataUnit.ts:593