npm - @sankhyalabs/core-docs - Versions diffs - 4.4.4 → 4.5.0 - Mend

@sankhyalabs/core-docs 4.4.4 → 4.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (15) hide show

package/classes/Change.md +11 -11
package/classes/DataUnit.md +52 -50
package/classes/ErrorException.md +8 -6
package/classes/SelectionInfo.md +11 -11
package/classes/WaitingChangeException.md +7 -5
package/classes/WarningException.md +8 -6
package/enums/ChangeOperation.md +4 -4
package/enums/SelectionMode.md +2 -2
package/interfaces/DUActionInterceptor.md +1 -1
package/interfaces/PageRequest.md +3 -3
package/interfaces/QuickFilter.md +3 -3
package/interfaces/Record.md +4 -4
package/interfaces/SavedRecord.md +5 -5
package/interfaces/WaitingChange.md +3 -3
package/package.json +1 -1

package/classes/Change.md CHANGED Viewed

@@ -47,7 +47,7 @@
 #### Defined in
-src/dataunit/DataUnit.ts:1600
+src/dataunit/DataUnit.ts:1603
 ## Properties
@@ -57,7 +57,7 @@ src/dataunit/DataUnit.ts:1600
 #### Defined in
-src/dataunit/DataUnit.ts:1598
+src/dataunit/DataUnit.ts:1601
 ___
@@ -67,7 +67,7 @@ ___
 #### Defined in
-src/dataunit/DataUnit.ts:1593
+src/dataunit/DataUnit.ts:1596
 ___
@@ -77,7 +77,7 @@ ___
 #### Defined in
-src/dataunit/DataUnit.ts:1594
+src/dataunit/DataUnit.ts:1597
 ___
@@ -87,7 +87,7 @@ ___
 #### Defined in
-src/dataunit/DataUnit.ts:1595
+src/dataunit/DataUnit.ts:1598
 ___
@@ -97,7 +97,7 @@ ___
 #### Defined in
-src/dataunit/DataUnit.ts:1596
+src/dataunit/DataUnit.ts:1599
 ## Accessors
@@ -115,7 +115,7 @@ Obtém o tipo de operação que está sendo realizada.
 #### Defined in
-src/dataunit/DataUnit.ts:1615
+src/dataunit/DataUnit.ts:1618
 ## Methods
@@ -133,7 +133,7 @@ Retorna se o DataUnit está em uma operação de cópia.
 #### Defined in
-src/dataunit/DataUnit.ts:1637
+src/dataunit/DataUnit.ts:1640
 ___
@@ -151,7 +151,7 @@ Retorna se o DataUnit está em uma operação de deleção.
 #### Defined in
-src/dataunit/DataUnit.ts:1648
+src/dataunit/DataUnit.ts:1651
 ___
@@ -169,7 +169,7 @@ Retorna se o DataUnit está em uma operação de inserção.
 #### Defined in
-src/dataunit/DataUnit.ts:1626
+src/dataunit/DataUnit.ts:1629
 ___
@@ -187,4 +187,4 @@ Retorna se o DataUnit está em uma operação de atualização.
 #### Defined in
-src/dataunit/DataUnit.ts:1659
+src/dataunit/DataUnit.ts:1662

package/classes/DataUnit.md CHANGED Viewed

@@ -646,7 +646,7 @@ Verdadeiro se for possível refazer a ação.
 #### Defined in
-src/dataunit/DataUnit.ts:1232
+src/dataunit/DataUnit.ts:1235
 ___
@@ -664,7 +664,7 @@ Verdadeiro se for possível desfazer a ação.
 #### Defined in
-src/dataunit/DataUnit.ts:1221
+src/dataunit/DataUnit.ts:1224
 ___
@@ -687,7 +687,7 @@ Cancela edição do registro atual.
 #### Defined in
-src/dataunit/DataUnit.ts:1090
+src/dataunit/DataUnit.ts:1093
 ___
@@ -709,7 +709,7 @@ Cancela o início de uma alteração no campo.
 #### Defined in
-src/dataunit/DataUnit.ts:890
+src/dataunit/DataUnit.ts:893
 ___
@@ -727,7 +727,7 @@ Verdadeiro se existir alterações pendentes em algum DataUnit detail.
 #### Defined in
-src/dataunit/DataUnit.ts:1117
+src/dataunit/DataUnit.ts:1120
 ___
@@ -743,7 +743,7 @@ Limpa todos os registros do DataUnit
 #### Defined in
-src/dataunit/DataUnit.ts:1024
+src/dataunit/DataUnit.ts:1027
 ___
@@ -766,7 +766,7 @@ Limpa campos inválidos.
 #### Defined in
-src/dataunit/DataUnit.ts:855
+src/dataunit/DataUnit.ts:858
 ___
@@ -788,7 +788,7 @@ Limpa a seleção.
 #### Defined in
-src/dataunit/DataUnit.ts:955
+src/dataunit/DataUnit.ts:958
 ___
@@ -832,7 +832,7 @@ Desabilita um campo do DataUnit
 #### Defined in
-src/dataunit/DataUnit.ts:1479
+src/dataunit/DataUnit.ts:1482
 ___
@@ -858,7 +858,7 @@ Lança ação do DataUnit para que sejam processadas.
 #### Defined in
-src/dataunit/DataUnit.ts:1282
+src/dataunit/DataUnit.ts:1285
 ___
@@ -880,7 +880,7 @@ Processa as ações no DataUnit e notifica os observers.
 #### Defined in
-src/dataunit/DataUnit.ts:1330
+src/dataunit/DataUnit.ts:1333
 ___
@@ -902,7 +902,7 @@ Habilita um campo do DataUnit
 #### Defined in
-src/dataunit/DataUnit.ts:1464
+src/dataunit/DataUnit.ts:1467
 ___
@@ -982,7 +982,7 @@ Obtém os filtros aplicados.
 #### Defined in
-src/dataunit/DataUnit.ts:1453
+src/dataunit/DataUnit.ts:1456
 ___
@@ -1004,7 +1004,7 @@ Cria um dataunit filho.
 #### Defined in
-src/dataunit/DataUnit.ts:1353
+src/dataunit/DataUnit.ts:1356
 ___
@@ -1118,7 +1118,7 @@ Obtém todos os filtros de dados.
 #### Defined in
-src/dataunit/DataUnit.ts:1435
+src/dataunit/DataUnit.ts:1438
 ___
@@ -1168,7 +1168,7 @@ Obtém a mensagem de campo inválido para determinado registro.
 #### Defined in
-src/dataunit/DataUnit.ts:867
+src/dataunit/DataUnit.ts:870
 ___
@@ -1276,7 +1276,7 @@ Retorna apenas um registro selecionado no Dataunit
 #### Defined in
-src/dataunit/DataUnit.ts:1012
+src/dataunit/DataUnit.ts:1015
 ___
@@ -1300,7 +1300,7 @@ método foi descontinuado e pode retornar erros no caso da seleção virtual.
 #### Defined in
-src/dataunit/DataUnit.ts:1529
+src/dataunit/DataUnit.ts:1532
 ___
@@ -1324,7 +1324,7 @@ método foi descontinuado e pode retornar erros no caso da seleção virtual.
 #### Defined in
-src/dataunit/DataUnit.ts:1553
+src/dataunit/DataUnit.ts:1556
 ___
@@ -1342,7 +1342,7 @@ Obtém informações sobre a seleção atual.
 #### Defined in
-src/dataunit/DataUnit.ts:1001
+src/dataunit/DataUnit.ts:1004
 ___
@@ -1360,7 +1360,7 @@ Obtém a estrutura de ordenação das colunas dos dados.
 #### Defined in
-src/dataunit/DataUnit.ts:1424
+src/dataunit/DataUnit.ts:1427
 ___
@@ -1403,7 +1403,7 @@ Verdadeiro se algum registro foi adicionado.
 #### Defined in
-src/dataunit/DataUnit.ts:1201
+src/dataunit/DataUnit.ts:1204
 ___
@@ -1421,7 +1421,7 @@ Verdadeiro se existir alterações de registros pendentes.
 #### Defined in
-src/dataunit/DataUnit.ts:1131
+src/dataunit/DataUnit.ts:1134
 ___
@@ -1439,7 +1439,7 @@ Verdadeiro se algum registro foi adicionado.
 #### Defined in
-src/dataunit/DataUnit.ts:1189
+src/dataunit/DataUnit.ts:1192
 ___
@@ -1457,7 +1457,7 @@ Verdadeiro se existir uma próxima página.
 #### Defined in
-src/dataunit/DataUnit.ts:1142
+src/dataunit/DataUnit.ts:1145
 ___
@@ -1475,7 +1475,7 @@ Verdadeiro se existir uma página anterior.
 #### Defined in
-src/dataunit/DataUnit.ts:1157
+src/dataunit/DataUnit.ts:1160
 ___
@@ -1497,7 +1497,7 @@ Deixa um campo do DataUnit invisível
 #### Defined in
-src/dataunit/DataUnit.ts:1494
+src/dataunit/DataUnit.ts:1497
 ___
@@ -1522,7 +1522,7 @@ Notifica os interceptors de que uma ação foi executada, para que cada intercep
 #### Defined in
-src/dataunit/DataUnit.ts:1313
+src/dataunit/DataUnit.ts:1316
 ___
@@ -1540,7 +1540,7 @@ Verdadeiro se existir alterações pendentes.
 #### Defined in
-src/dataunit/DataUnit.ts:1106
+src/dataunit/DataUnit.ts:1109
 ___
@@ -1564,7 +1564,7 @@ Verdadeiro se o id solicitado é de um registro novo.
 #### Defined in
-src/dataunit/DataUnit.ts:1173
+src/dataunit/DataUnit.ts:1176
 ___
@@ -1680,7 +1680,7 @@ Seleciona o próximo registro.
 #### Defined in
-src/dataunit/DataUnit.ts:1036
+src/dataunit/DataUnit.ts:1039
 ___
@@ -1768,7 +1768,7 @@ Seleciona o registro anterior.
 #### Defined in
-src/dataunit/DataUnit.ts:1063
+src/dataunit/DataUnit.ts:1066
 ___
@@ -1790,7 +1790,7 @@ Refaz a última ação.
 #### Defined in
-src/dataunit/DataUnit.ts:1255
+src/dataunit/DataUnit.ts:1258
 ___
@@ -1824,7 +1824,7 @@ Recarrega registro selecionado com dados atualizados do servidor.
 #### Defined in
-src/dataunit/DataUnit.ts:1400
+src/dataunit/DataUnit.ts:1403
 ___
@@ -1846,7 +1846,7 @@ Remove um dataunit filho.
 #### Defined in
-src/dataunit/DataUnit.ts:1366
+src/dataunit/DataUnit.ts:1369
 ___
@@ -1965,7 +1965,7 @@ Seleciona o primeiro registro.
 #### Defined in
-src/dataunit/DataUnit.ts:901
+src/dataunit/DataUnit.ts:904
 ___
@@ -1987,13 +1987,13 @@ Seleciona o último registro.
 #### Defined in
-src/dataunit/DataUnit.ts:914
+src/dataunit/DataUnit.ts:917
 ___
 ### setFieldValue
-▸ **setFieldValue**(`fieldName`, `newValue`, `records?`): `void`
+▸ **setFieldValue**(`fieldName`, `newValue`, `records?`): `Promise`<`boolean`\>
 Insere valor no campo desejado.
@@ -2007,11 +2007,13 @@ Insere valor no campo desejado.
 #### Returns
-`void`
+`Promise`<`boolean`\>
+- Promise que será resolvida quando o novo valor for persistido no state.
 #### Defined in
-src/dataunit/DataUnit.ts:824
+src/dataunit/DataUnit.ts:825
 ___
@@ -2035,7 +2037,7 @@ Marca campos como inválidos.
 #### Defined in
-src/dataunit/DataUnit.ts:843
+src/dataunit/DataUnit.ts:846
 ___
@@ -2058,7 +2060,7 @@ Seleciona múltiplos registros por ID ou todos os registros (multipágina) .
 #### Defined in
-src/dataunit/DataUnit.ts:941
+src/dataunit/DataUnit.ts:944
 ___
@@ -2081,7 +2083,7 @@ Seleciona múltiplos registros por índice.
 #### Defined in
-src/dataunit/DataUnit.ts:928
+src/dataunit/DataUnit.ts:931
 ___
@@ -2103,7 +2105,7 @@ Deixa um campo do DataUnit visível
 #### Defined in
-src/dataunit/DataUnit.ts:1509
+src/dataunit/DataUnit.ts:1512
 ___
@@ -2126,7 +2128,7 @@ Inicia alteração no campo.
 #### Defined in
-src/dataunit/DataUnit.ts:879
+src/dataunit/DataUnit.ts:882
 ___
@@ -2149,7 +2151,7 @@ Ela vai ser chamada sempre que uma ação for despachada (dispatchAction()).
 #### Defined in
-src/dataunit/DataUnit.ts:1378
+src/dataunit/DataUnit.ts:1381
 ___
@@ -2167,7 +2169,7 @@ Obtém a representação textual do DataUnit, nesse caso, o nome do DataUnit.
 #### Defined in
-src/dataunit/DataUnit.ts:1266
+src/dataunit/DataUnit.ts:1269
 ___
@@ -2189,7 +2191,7 @@ Desfaz a última ação.
 #### Defined in
-src/dataunit/DataUnit.ts:1244
+src/dataunit/DataUnit.ts:1247
 ___
@@ -2211,7 +2213,7 @@ Remove um observer existente.
 #### Defined in
-src/dataunit/DataUnit.ts:1389
+src/dataunit/DataUnit.ts:1392
 ___
@@ -2236,7 +2238,7 @@ Atualiza a seleção dos registros atuais.
 #### Defined in
-src/dataunit/DataUnit.ts:968
+src/dataunit/DataUnit.ts:971
 ___

package/classes/ErrorException.md CHANGED Viewed

@@ -51,7 +51,7 @@ Error.constructor
 #### Defined in
-src/exceptions/ErrorException.ts:15
+src/exceptions/ErrorException.ts:18
 ## Properties
@@ -77,7 +77,7 @@ Código do erro, indica o erro disparado pelo backend.
 #### Defined in
-src/exceptions/ErrorException.ts:13
+src/exceptions/ErrorException.ts:16
 ___
@@ -93,7 +93,7 @@ Error.message
 #### Defined in
-src/exceptions/ErrorException.ts:10
+src/exceptions/ErrorException.ts:13
 ___
@@ -101,13 +101,15 @@ ___
 • **name**: `string`
-#### Inherited from
+Nome da exceção.
+#### Overrides
 Error.name
 #### Defined in
-node_modules/typescript/lib/lib.es5.d.ts:1053
+src/exceptions/ErrorException.ts:7
 ___
@@ -133,7 +135,7 @@ Titulo do erro.
 #### Defined in
-src/exceptions/ErrorException.ts:7
+src/exceptions/ErrorException.ts:10
 ___

package/classes/SelectionInfo.md CHANGED Viewed

@@ -45,7 +45,7 @@
 #### Defined in
-src/dataunit/DataUnit.ts:1704
+src/dataunit/DataUnit.ts:1707
 ## Properties
@@ -55,7 +55,7 @@ src/dataunit/DataUnit.ts:1704
 #### Defined in
-src/dataunit/DataUnit.ts:1698
+src/dataunit/DataUnit.ts:1701
 ___
@@ -65,7 +65,7 @@ ___
 #### Defined in
-src/dataunit/DataUnit.ts:1700
+src/dataunit/DataUnit.ts:1703
 ___
@@ -75,7 +75,7 @@ ___
 #### Defined in
-src/dataunit/DataUnit.ts:1701
+src/dataunit/DataUnit.ts:1704
 ___
@@ -85,7 +85,7 @@ ___
 #### Defined in
-src/dataunit/DataUnit.ts:1699
+src/dataunit/DataUnit.ts:1702
 ___
@@ -95,7 +95,7 @@ ___
 #### Defined in
-src/dataunit/DataUnit.ts:1702
+src/dataunit/DataUnit.ts:1705
 ## Accessors
@@ -109,7 +109,7 @@ src/dataunit/DataUnit.ts:1702
 #### Defined in
-src/dataunit/DataUnit.ts:1729
+src/dataunit/DataUnit.ts:1732
 ___
@@ -123,7 +123,7 @@ ___
 #### Defined in
-src/dataunit/DataUnit.ts:1719
+src/dataunit/DataUnit.ts:1722
 ___
@@ -137,7 +137,7 @@ ___
 #### Defined in
-src/dataunit/DataUnit.ts:1712
+src/dataunit/DataUnit.ts:1715
 ## Methods
@@ -151,7 +151,7 @@ src/dataunit/DataUnit.ts:1712
 #### Defined in
-src/dataunit/DataUnit.ts:1736
+src/dataunit/DataUnit.ts:1739
 ___
@@ -165,4 +165,4 @@ ___
 #### Defined in
-src/dataunit/DataUnit.ts:1740
+src/dataunit/DataUnit.ts:1743

package/classes/WaitingChangeException.md CHANGED Viewed

@@ -49,7 +49,7 @@ Error.constructor
 #### Defined in
-src/exceptions/WaitingChangeException.ts:12
+src/exceptions/WaitingChangeException.ts:15
 ## Properties
@@ -79,7 +79,7 @@ Error.message
 #### Defined in
-src/exceptions/WaitingChangeException.ts:10
+src/exceptions/WaitingChangeException.ts:13
 ___
@@ -87,13 +87,15 @@ ___
 • **name**: `string`
-#### Inherited from
+Nome da exceção.
+#### Overrides
 Error.name
 #### Defined in
-node_modules/typescript/lib/lib.es5.d.ts:1053
+src/exceptions/WaitingChangeException.ts:7
 ___
@@ -119,7 +121,7 @@ Titulo do erro.
 #### Defined in
-src/exceptions/WaitingChangeException.ts:7
+src/exceptions/WaitingChangeException.ts:10
 ___

package/classes/WarningException.md CHANGED Viewed

@@ -51,7 +51,7 @@ Error.constructor
 #### Defined in
-src/exceptions/WarningException.ts:15
+src/exceptions/WarningException.ts:18
 ## Properties
@@ -77,7 +77,7 @@ Código do alerta, indica o alerta disparado pelo backend.
 #### Defined in
-src/exceptions/WarningException.ts:13
+src/exceptions/WarningException.ts:16
 ___
@@ -93,7 +93,7 @@ Error.message
 #### Defined in
-src/exceptions/WarningException.ts:10
+src/exceptions/WarningException.ts:13
 ___
@@ -101,13 +101,15 @@ ___
 • **name**: `string`
-#### Inherited from
+Nome da exceção.
+#### Overrides
 Error.name
 #### Defined in
-node_modules/typescript/lib/lib.es5.d.ts:1053
+src/exceptions/WarningException.ts:7
 ___
@@ -133,7 +135,7 @@ Titulo do alerta.
 #### Defined in
-src/exceptions/WarningException.ts:7
+src/exceptions/WarningException.ts:10
 ___

package/enums/ChangeOperation.md CHANGED Viewed

@@ -19,7 +19,7 @@
 #### Defined in
-src/dataunit/DataUnit.ts:1583
+src/dataunit/DataUnit.ts:1586
 ___
@@ -29,7 +29,7 @@ ___
 #### Defined in
-src/dataunit/DataUnit.ts:1585
+src/dataunit/DataUnit.ts:1588
 ___
@@ -39,7 +39,7 @@ ___
 #### Defined in
-src/dataunit/DataUnit.ts:1582
+src/dataunit/DataUnit.ts:1585
 ___
@@ -49,4 +49,4 @@ ___
 #### Defined in
-src/dataunit/DataUnit.ts:1584
+src/dataunit/DataUnit.ts:1587

package/enums/SelectionMode.md CHANGED Viewed

@@ -17,7 +17,7 @@
 #### Defined in
-src/dataunit/DataUnit.ts:1692
+src/dataunit/DataUnit.ts:1695
 ___
@@ -27,4 +27,4 @@ ___
 #### Defined in
-src/dataunit/DataUnit.ts:1693
+src/dataunit/DataUnit.ts:1696

package/interfaces/DUActionInterceptor.md CHANGED Viewed

@@ -26,4 +26,4 @@
 #### Defined in
-src/dataunit/DataUnit.ts:1566
+src/dataunit/DataUnit.ts:1569

package/interfaces/PageRequest.md CHANGED Viewed

@@ -18,7 +18,7 @@
 #### Defined in
-src/dataunit/DataUnit.ts:1672
+src/dataunit/DataUnit.ts:1675
 ___
@@ -28,7 +28,7 @@ ___
 #### Defined in
-src/dataunit/DataUnit.ts:1673
+src/dataunit/DataUnit.ts:1676
 ___
@@ -38,4 +38,4 @@ ___
 #### Defined in
-src/dataunit/DataUnit.ts:1674
+src/dataunit/DataUnit.ts:1677

package/interfaces/QuickFilter.md CHANGED Viewed

@@ -18,7 +18,7 @@
 #### Defined in
-src/dataunit/DataUnit.ts:1679
+src/dataunit/DataUnit.ts:1682
 ___
@@ -28,7 +28,7 @@ ___
 #### Defined in
-src/dataunit/DataUnit.ts:1680
+src/dataunit/DataUnit.ts:1683
 ___
@@ -38,4 +38,4 @@ ___
 #### Defined in
-src/dataunit/DataUnit.ts:1678
+src/dataunit/DataUnit.ts:1681

package/interfaces/Record.md CHANGED Viewed

@@ -29,7 +29,7 @@
 #### Defined in
-src/dataunit/DataUnit.ts:1573
+src/dataunit/DataUnit.ts:1576
 ___
@@ -39,7 +39,7 @@ ___
 #### Defined in
-src/dataunit/DataUnit.ts:1572
+src/dataunit/DataUnit.ts:1575
 ___
@@ -49,7 +49,7 @@ ___
 #### Defined in
-src/dataunit/DataUnit.ts:1570
+src/dataunit/DataUnit.ts:1573
 ___
@@ -59,4 +59,4 @@ ___
 #### Defined in
-src/dataunit/DataUnit.ts:1571
+src/dataunit/DataUnit.ts:1574

package/interfaces/SavedRecord.md CHANGED Viewed

@@ -26,7 +26,7 @@
 #### Defined in
-src/dataunit/DataUnit.ts:1578
+src/dataunit/DataUnit.ts:1581
 ___
@@ -40,7 +40,7 @@ ___
 #### Defined in
-src/dataunit/DataUnit.ts:1573
+src/dataunit/DataUnit.ts:1576
 ___
@@ -54,7 +54,7 @@ ___
 #### Defined in
-src/dataunit/DataUnit.ts:1572
+src/dataunit/DataUnit.ts:1575
 ___
@@ -68,7 +68,7 @@ ___
 #### Defined in
-src/dataunit/DataUnit.ts:1570
+src/dataunit/DataUnit.ts:1573
 ___
@@ -82,4 +82,4 @@ ___
 #### Defined in
-src/dataunit/DataUnit.ts:1571
+src/dataunit/DataUnit.ts:1574

package/interfaces/WaitingChange.md CHANGED Viewed

@@ -18,7 +18,7 @@
 #### Defined in
-src/dataunit/DataUnit.ts:1667
+src/dataunit/DataUnit.ts:1670
 ___
@@ -28,7 +28,7 @@ ___
 #### Defined in
-src/dataunit/DataUnit.ts:1668
+src/dataunit/DataUnit.ts:1671
 ___
@@ -38,4 +38,4 @@ ___
 #### Defined in
-src/dataunit/DataUnit.ts:1666
+src/dataunit/DataUnit.ts:1669

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
     "name": "@sankhyalabs/core-docs",
-    "version": "4.4.4",
+    "version": "4.5.0",
     "description": "Documentação da biblioteca de componentes Sankhya.",
     "main": "",
     "files": [