npm - @sankhyalabs/core-docs - Versions diffs - 0.0.0-hotfix-ga-5330358.0 → 0.0.0-hotfix-rc-KB-46291.1 - Mend

@sankhyalabs/core-docs 0.0.0-hotfix-ga-5330358.0 → 0.0.0-hotfix-rc-KB-46291.1

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 (17) hide show

package/classes/Change.md +11 -11
package/classes/DataUnit.md +101 -95
package/classes/OverflowWatcher.md +310 -46
package/classes/SelectionInfo.md +11 -11
package/enumerations/ChangeOperation.md +4 -4
package/enumerations/SelectionMode.md +2 -2
package/globals.md +6 -0
package/interfaces/DUActionInterceptor.md +1 -1
package/interfaces/OverFlowWatcherParams.md +67 -0
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/type-aliases/DataUnitEventOptions.md +17 -0
package/variables/OVERFLOWED_CLASS_NAME.md +13 -0

package/classes/DataUnit.md CHANGED Viewed

@@ -62,7 +62,7 @@ src/dataunit/DataUnit.ts:42
 ### \_interceptors
-> `private` **\_interceptors**: [`DUActionInterceptor`](../interfaces/DUActionInterceptor.md)[]
+> `private` **\_interceptors**: `Map`\<`string`, [`DUActionInterceptor`](../interfaces/DUActionInterceptor.md)\>
 #### Source
@@ -92,7 +92,7 @@ src/dataunit/DataUnit.ts:39
 ### \_observers
-> `private` **\_observers**: (`action`) => `void`[]
+> `private` **\_observers**: (`action`, `options`?) => `void`[]
 #### Source
@@ -306,7 +306,7 @@ Ordenação padrão.
 #### Source
-src/dataunit/DataUnit.ts:743
+src/dataunit/DataUnit.ts:745
 ***
@@ -330,7 +330,7 @@ Define a propriedade metadata da instância da classe com um novo valor e chama
 #### Source
-src/dataunit/DataUnit.ts:761
+src/dataunit/DataUnit.ts:763
 ***
@@ -376,7 +376,7 @@ Quantidade de registros que será exibido por página.
 #### Source
-src/dataunit/DataUnit.ts:822
+src/dataunit/DataUnit.ts:824
 ***
@@ -402,7 +402,7 @@ Define a propriedade records da instância da classe com um novo valor e chama o
 #### Source
-src/dataunit/DataUnit.ts:799
+src/dataunit/DataUnit.ts:801
 ***
@@ -420,7 +420,7 @@ Objeto usado para definir a propriedade sortingProvider da instância da classe.
 #### Source
-src/dataunit/DataUnit.ts:732
+src/dataunit/DataUnit.ts:734
 ## Methods
@@ -442,7 +442,7 @@ Campo a ser adicionado.
 #### Source
-src/dataunit/DataUnit.ts:1749
+src/dataunit/DataUnit.ts:1751
 ***
@@ -464,7 +464,7 @@ FilterProvider que será adicionado.
 #### Source
-src/dataunit/DataUnit.ts:690
+src/dataunit/DataUnit.ts:692
 ***
@@ -514,7 +514,7 @@ Interceptor a ser adicionado.
 #### Source
-src/dataunit/DataUnit.ts:668
+src/dataunit/DataUnit.ts:670
 ***
@@ -532,7 +532,7 @@ Retorna uma função responsável por liberar o lock adicionado.
 #### Source
-src/dataunit/DataUnit.ts:1758
+src/dataunit/DataUnit.ts:1760
 ***
@@ -554,7 +554,7 @@ Contexto de execução da inserção do dado no DataUnit.
 #### Source
-src/dataunit/DataUnit.ts:868
+src/dataunit/DataUnit.ts:870
 ***
@@ -574,7 +574,7 @@ Adiciona um campo stand-alone ao dataUnit.
 #### Source
-src/dataunit/DataUnit.ts:1740
+src/dataunit/DataUnit.ts:1742
 ***
@@ -592,7 +592,7 @@ Retorna as alterações a serem salvas no DataUnit atual.
 #### Source
-src/dataunit/DataUnit.ts:499
+src/dataunit/DataUnit.ts:502
 ***
@@ -612,7 +612,7 @@ src/dataunit/DataUnit.ts:499
 #### Source
-src/dataunit/DataUnit.ts:503
+src/dataunit/DataUnit.ts:506
 ***
@@ -630,7 +630,7 @@ Verdadeiro se for possível refazer a ação.
 #### Source
-src/dataunit/DataUnit.ts:1388
+src/dataunit/DataUnit.ts:1390
 ***
@@ -648,7 +648,7 @@ Verdadeiro se for possível desfazer a ação.
 #### Source
-src/dataunit/DataUnit.ts:1377
+src/dataunit/DataUnit.ts:1379
 ***
@@ -674,7 +674,7 @@ Contexto de execução do cancelamento da seleção dos registros.
 #### Source
-src/dataunit/DataUnit.ts:1244
+src/dataunit/DataUnit.ts:1246
 ***
@@ -696,7 +696,7 @@ Identificador do campo.
 #### Source
-src/dataunit/DataUnit.ts:1035
+src/dataunit/DataUnit.ts:1037
 ***
@@ -714,7 +714,7 @@ Verdadeiro se existir alterações pendentes em algum DataUnit detail.
 #### Source
-src/dataunit/DataUnit.ts:1273
+src/dataunit/DataUnit.ts:1275
 ***
@@ -730,7 +730,7 @@ Limpa todos os registros do DataUnit
 #### Source
-src/dataunit/DataUnit.ts:1177
+src/dataunit/DataUnit.ts:1179
 ***
@@ -756,7 +756,7 @@ Nome do campo. Caso omitido, todos os campos serão limpos.
 #### Source
-src/dataunit/DataUnit.ts:1000
+src/dataunit/DataUnit.ts:1002
 ***
@@ -778,7 +778,7 @@ Contexto de execução da seleção dos registros do DataUnit.
 #### Source
-src/dataunit/DataUnit.ts:1110
+src/dataunit/DataUnit.ts:1112
 ***
@@ -800,7 +800,7 @@ Contexto de execução da cópia do dado do DataUnit.
 #### Source
-src/dataunit/DataUnit.ts:879
+src/dataunit/DataUnit.ts:881
 ***
@@ -822,13 +822,13 @@ nome do campo para ficar desabilitado.
 #### Source
-src/dataunit/DataUnit.ts:1650
+src/dataunit/DataUnit.ts:1652
 ***
 ### dispatchAction()
-> `private` **dispatchAction**(`actionType`, `payload`?, `executionCtx`?): `Promise`\<`boolean`\>
+> `private` **dispatchAction**(`actionType`, `payload`?, `executionCtx`?, `options`?): `Promise`\<`boolean`\>
 Lança ação do DataUnit para que sejam processadas.
@@ -846,6 +846,8 @@ Dados que serão processados na ação.
 Contexto de execução de lançar a ação que será executada.
+• **options?**: [`DataUnitEventOptions`](../type-aliases/DataUnitEventOptions.md)
 #### Returns
 `Promise`\<`boolean`\>
@@ -854,13 +856,13 @@ Contexto de execução de lançar a ação que será executada.
 #### Source
-src/dataunit/DataUnit.ts:1438
+src/dataunit/DataUnit.ts:1440
 ***
 ### doDispatchAction()
-> `private` **doDispatchAction**(`action`): `void`
+> `private` **doDispatchAction**(`action`, `options`): `void`
 Processa as ações no DataUnit e notifica os observers.
@@ -870,13 +872,15 @@ Processa as ações no DataUnit e notifica os observers.
 Ações em execução no DataUnit.
+• **options**: [`DataUnitEventOptions`](../type-aliases/DataUnitEventOptions.md)= `{}`
 #### Returns
 `void`
 #### Source
-src/dataunit/DataUnit.ts:1486
+src/dataunit/DataUnit.ts:1488
 ***
@@ -898,7 +902,7 @@ nome do campo para ser habilitado.
 #### Source
-src/dataunit/DataUnit.ts:1635
+src/dataunit/DataUnit.ts:1637
 ***
@@ -950,7 +954,7 @@ Obtém os registros adicionados no DataUnit.
 #### Source
-src/dataunit/DataUnit.ts:845
+src/dataunit/DataUnit.ts:847
 ***
@@ -968,7 +972,7 @@ Retorna todas as alterações do DataUnit a serem salvas, incluindo no nível Ma
 #### Source
-src/dataunit/DataUnit.ts:521
+src/dataunit/DataUnit.ts:524
 ***
@@ -986,7 +990,7 @@ Obtém os filtros aplicados.
 #### Source
-src/dataunit/DataUnit.ts:1624
+src/dataunit/DataUnit.ts:1626
 ***
@@ -1000,7 +1004,7 @@ src/dataunit/DataUnit.ts:1624
 #### Source
-src/dataunit/DataUnit.ts:426
+src/dataunit/DataUnit.ts:429
 ***
@@ -1022,7 +1026,7 @@ Nome do dataunit filho.
 #### Source
-src/dataunit/DataUnit.ts:1509
+src/dataunit/DataUnit.ts:1511
 ***
@@ -1046,7 +1050,7 @@ Nome do DataUnit que se deseja.
 #### Source
-src/dataunit/DataUnit.ts:774
+src/dataunit/DataUnit.ts:776
 ***
@@ -1070,7 +1074,7 @@ Identificador do campo.
 #### Source
-src/dataunit/DataUnit.ts:857
+src/dataunit/DataUnit.ts:859
 ***
@@ -1094,7 +1098,7 @@ Identificador do campo a ser buscado.
 #### Source
-src/dataunit/DataUnit.ts:938
+src/dataunit/DataUnit.ts:940
 ***
@@ -1136,7 +1140,7 @@ Obtém todos os filtros de dados.
 #### Source
-src/dataunit/DataUnit.ts:1595
+src/dataunit/DataUnit.ts:1597
 ***
@@ -1167,7 +1171,7 @@ Nome do campo utilizado do qual se quer obter valor.
 #### Source
-src/dataunit/DataUnit.ts:645
+src/dataunit/DataUnit.ts:648
 ***
@@ -1211,7 +1215,7 @@ Nome do campo.
 #### Source
-src/dataunit/DataUnit.ts:1012
+src/dataunit/DataUnit.ts:1014
 ***
@@ -1229,7 +1233,7 @@ Obtém as informações da última carga de dados.
 #### Source
-src/dataunit/DataUnit.ts:1613
+src/dataunit/DataUnit.ts:1615
 ***
@@ -1249,7 +1253,7 @@ src/dataunit/DataUnit.ts:1613
 #### Source
-src/dataunit/DataUnit.ts:391
+src/dataunit/DataUnit.ts:394
 ***
@@ -1267,7 +1271,7 @@ Obtém os registros modificados e ainda não salvos no DataUnit.
 #### Source
-src/dataunit/DataUnit.ts:833
+src/dataunit/DataUnit.ts:835
 ***
@@ -1285,7 +1289,7 @@ Obtém informações de paginação dos registros.
 #### Source
-src/dataunit/DataUnit.ts:711
+src/dataunit/DataUnit.ts:713
 ***
@@ -1299,7 +1303,7 @@ src/dataunit/DataUnit.ts:711
 #### Source
-src/dataunit/DataUnit.ts:911
+src/dataunit/DataUnit.ts:913
 ***
@@ -1317,7 +1321,7 @@ src/dataunit/DataUnit.ts:911
 #### Source
-src/dataunit/DataUnit.ts:889
+src/dataunit/DataUnit.ts:891
 ***
@@ -1335,7 +1339,7 @@ Retorna apenas um registro selecionado no Dataunit
 #### Source
-src/dataunit/DataUnit.ts:1167
+src/dataunit/DataUnit.ts:1169
 ***
@@ -1359,7 +1363,7 @@ método foi descontinuado e pode retornar erros no caso da seleção virtual.
 #### Source
-src/dataunit/DataUnit.ts:1700
+src/dataunit/DataUnit.ts:1702
 ***
@@ -1383,7 +1387,7 @@ método foi descontinuado e pode retornar erros no caso da seleção virtual.
 #### Source
-src/dataunit/DataUnit.ts:1724
+src/dataunit/DataUnit.ts:1726
 ***
@@ -1401,7 +1405,7 @@ Obtém informações sobre a seleção atual.
 #### Source
-src/dataunit/DataUnit.ts:1156
+src/dataunit/DataUnit.ts:1158
 ***
@@ -1419,7 +1423,7 @@ Obtém a estrutura de ordenação das colunas dos dados.
 #### Source
-src/dataunit/DataUnit.ts:1584
+src/dataunit/DataUnit.ts:1586
 ***
@@ -1447,7 +1451,7 @@ Contexto de execução do carregamento dos registros do DataUnit.
 #### Source
-src/dataunit/DataUnit.ts:343
+src/dataunit/DataUnit.ts:346
 ***
@@ -1465,7 +1469,7 @@ Verdadeiro se algum registro foi adicionado.
 #### Source
-src/dataunit/DataUnit.ts:1357
+src/dataunit/DataUnit.ts:1359
 ***
@@ -1483,7 +1487,7 @@ Verdadeiro se existir alterações de registros pendentes.
 #### Source
-src/dataunit/DataUnit.ts:1287
+src/dataunit/DataUnit.ts:1289
 ***
@@ -1501,7 +1505,7 @@ Verdadeiro se algum registro foi adicionado.
 #### Source
-src/dataunit/DataUnit.ts:1345
+src/dataunit/DataUnit.ts:1347
 ***
@@ -1519,7 +1523,7 @@ Verdadeiro se existir uma próxima página.
 #### Source
-src/dataunit/DataUnit.ts:1298
+src/dataunit/DataUnit.ts:1300
 ***
@@ -1537,7 +1541,7 @@ Verdadeiro se existir uma página anterior.
 #### Source
-src/dataunit/DataUnit.ts:1313
+src/dataunit/DataUnit.ts:1315
 ***
@@ -1555,7 +1559,7 @@ Verdadeiro se existir pendências de modificações.
 #### Source
-src/dataunit/DataUnit.ts:1043
+src/dataunit/DataUnit.ts:1045
 ***
@@ -1577,7 +1581,7 @@ nome do campo para ficar invisível.
 #### Source
-src/dataunit/DataUnit.ts:1665
+src/dataunit/DataUnit.ts:1667
 ***
@@ -1605,7 +1609,7 @@ Interceptors que serão notificados.
 #### Source
-src/dataunit/DataUnit.ts:1469
+src/dataunit/DataUnit.ts:1471
 ***
@@ -1623,7 +1627,7 @@ Verdadeiro se existir alterações pendentes.
 #### Source
-src/dataunit/DataUnit.ts:1262
+src/dataunit/DataUnit.ts:1264
 ***
@@ -1647,7 +1651,7 @@ Verdadeiro se o id solicitado é de um registro novo.
 #### Source
-src/dataunit/DataUnit.ts:1329
+src/dataunit/DataUnit.ts:1331
 ***
@@ -1749,7 +1753,7 @@ Contexto de execução do carregamento dos registros do DataUnit.
 #### Source
-src/dataunit/DataUnit.ts:374
+src/dataunit/DataUnit.ts:377
 ***
@@ -1771,7 +1775,7 @@ Contexto de execução da seleção do registro do DataUnit.
 #### Source
-src/dataunit/DataUnit.ts:1189
+src/dataunit/DataUnit.ts:1191
 ***
@@ -1789,7 +1793,7 @@ src/dataunit/DataUnit.ts:1189
 #### Source
-src/dataunit/DataUnit.ts:411
+src/dataunit/DataUnit.ts:414
 ***
@@ -1833,7 +1837,7 @@ Contexto de execução do carregamento dos registros do DataUnit.
 #### Source
-src/dataunit/DataUnit.ts:387
+src/dataunit/DataUnit.ts:390
 ***
@@ -1855,7 +1859,7 @@ Contexto de execução da seleção do registro do DataUnit.
 #### Source
-src/dataunit/DataUnit.ts:1216
+src/dataunit/DataUnit.ts:1218
 ***
@@ -1869,7 +1873,7 @@ src/dataunit/DataUnit.ts:1216
 #### Source
-src/dataunit/DataUnit.ts:1768
+src/dataunit/DataUnit.ts:1770
 ***
@@ -1891,7 +1895,7 @@ Contexto de execução de refazer a última ação.
 #### Source
-src/dataunit/DataUnit.ts:1411
+src/dataunit/DataUnit.ts:1413
 ***
@@ -1948,7 +1952,7 @@ Recarrega registro selecionado com dados atualizados do servidor.
 #### Source
-src/dataunit/DataUnit.ts:1556
+src/dataunit/DataUnit.ts:1558
 ***
@@ -1970,7 +1974,7 @@ Nome do dataunit filho.
 #### Source
-src/dataunit/DataUnit.ts:1522
+src/dataunit/DataUnit.ts:1524
 ***
@@ -1992,7 +1996,7 @@ FilterProvider que será removido.
 #### Source
-src/dataunit/DataUnit.ts:701
+src/dataunit/DataUnit.ts:703
 ***
@@ -2014,7 +2018,7 @@ Interceptor a ser removido.
 #### Source
-src/dataunit/DataUnit.ts:679
+src/dataunit/DataUnit.ts:681
 ***
@@ -2054,7 +2058,7 @@ Define se haverá mensagem de confirmação da remoção
 #### Source
-src/dataunit/DataUnit.ts:564
+src/dataunit/DataUnit.ts:567
 ***
@@ -2082,7 +2086,7 @@ Define se haverá mensagem de confirmação da remoção
 #### Source
-src/dataunit/DataUnit.ts:538
+src/dataunit/DataUnit.ts:541
 ***
@@ -2124,7 +2128,7 @@ Contexto de execução da persistencia do registro do DataUnit.
 #### Source
-src/dataunit/DataUnit.ts:441
+src/dataunit/DataUnit.ts:444
 ***
@@ -2146,7 +2150,7 @@ Contexto de execução da seleção do registro do DataUnit.
 #### Source
-src/dataunit/DataUnit.ts:1056
+src/dataunit/DataUnit.ts:1058
 ***
@@ -2168,13 +2172,13 @@ Contexto de execução da seleção do registro do DataUnit.
 #### Source
-src/dataunit/DataUnit.ts:1069
+src/dataunit/DataUnit.ts:1071
 ***
 ### setFieldValue()
-> **setFieldValue**(`fieldName`, `newValue`, `records`?): `Promise`\<`boolean`\>
+> **setFieldValue**(`fieldName`, `newValue`, `records`?, `options`?): `Promise`\<`boolean`\>
 Insere valor no campo desejado.
@@ -2192,6 +2196,8 @@ Valor a ser inserido no campo.
 Indica quais registros foram afetados pela alteração no valor do campo.
+• **options?**: [`DataUnitEventOptions`](../type-aliases/DataUnitEventOptions.md)
 #### Returns
 `Promise`\<`boolean`\>
@@ -2200,7 +2206,7 @@ Indica quais registros foram afetados pela alteração no valor do campo.
 #### Source
-src/dataunit/DataUnit.ts:952
+src/dataunit/DataUnit.ts:954
 ***
@@ -2230,7 +2236,7 @@ Indica qual registro está com o campo inválido.
 #### Source
-src/dataunit/DataUnit.ts:988
+src/dataunit/DataUnit.ts:990
 ***
@@ -2256,7 +2262,7 @@ Contexto de execução da seleção dos registros do DataUnit.
 #### Source
-src/dataunit/DataUnit.ts:1096
+src/dataunit/DataUnit.ts:1098
 ***
@@ -2282,7 +2288,7 @@ Contexto de execução da seleção do registro do DataUnit.
 #### Source
-src/dataunit/DataUnit.ts:1083
+src/dataunit/DataUnit.ts:1085
 ***
@@ -2304,7 +2310,7 @@ nome do campo para ficar visível.
 #### Source
-src/dataunit/DataUnit.ts:1680
+src/dataunit/DataUnit.ts:1682
 ***
@@ -2330,7 +2336,7 @@ Informa que uma mudança irá iniciar.
 #### Source
-src/dataunit/DataUnit.ts:1024
+src/dataunit/DataUnit.ts:1026
 ***
@@ -2353,7 +2359,7 @@ Função que recebe como parâmetro as ações que serão monitoradas.
 #### Source
-src/dataunit/DataUnit.ts:1534
+src/dataunit/DataUnit.ts:1536
 ***
@@ -2371,7 +2377,7 @@ Obtém a representação textual do DataUnit, nesse caso, o nome do DataUnit.
 #### Source
-src/dataunit/DataUnit.ts:1422
+src/dataunit/DataUnit.ts:1424
 ***
@@ -2393,7 +2399,7 @@ Contexto de execução de desfazer a última ação.
 #### Source
-src/dataunit/DataUnit.ts:1400
+src/dataunit/DataUnit.ts:1402
 ***
@@ -2415,7 +2421,7 @@ Observer que se deseja remover.
 #### Source
-src/dataunit/DataUnit.ts:1545
+src/dataunit/DataUnit.ts:1547
 ***
@@ -2443,7 +2449,7 @@ Contexto de execução da seleção dos registros do DataUnit.
 #### Source
-src/dataunit/DataUnit.ts:1123
+src/dataunit/DataUnit.ts:1125
 ***
@@ -2465,7 +2471,7 @@ Obtém informações de paginação dos registros.
 #### Source
-src/dataunit/DataUnit.ts:721
+src/dataunit/DataUnit.ts:723
 ***
@@ -2521,7 +2527,7 @@ Texto que será convertido de acordo com o tipo identificado no campo.
 #### Source
-src/dataunit/DataUnit.ts:612
+src/dataunit/DataUnit.ts:615
 ***
@@ -2549,7 +2555,7 @@ Valor a ser convertido.
 #### Source
-src/dataunit/DataUnit.ts:627
+src/dataunit/DataUnit.ts:630
 ***
@@ -2573,4 +2579,4 @@ Identificador do campo a ser verificado.
 #### Source
-src/dataunit/DataUnit.ts:925
+src/dataunit/DataUnit.ts:927