@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.
Files changed (31) hide show
  1. package/classes/ApplicationContext.md +24 -10
  2. package/classes/ArrayUtils.md +24 -14
  3. package/classes/Change.md +40 -18
  4. package/classes/DataUnit.md +418 -225
  5. package/classes/DateUtils.md +95 -36
  6. package/classes/ElementIDUtils.md +70 -37
  7. package/classes/ErrorException.md +12 -4
  8. package/classes/ErrorTracking.md +13 -5
  9. package/classes/FloatingManager.md +104 -63
  10. package/classes/MaskFormatter-1.md +17 -17
  11. package/classes/NumberUtils.md +74 -35
  12. package/classes/ObjectUtils.md +34 -12
  13. package/classes/ReadyUtil.md +18 -6
  14. package/classes/StringUtils.md +108 -52
  15. package/classes/TimeFormatter.md +9 -9
  16. package/classes/UserAgentUtils.md +12 -2
  17. package/classes/WaitingChangeException.md +9 -3
  18. package/classes/WarningException.md +12 -4
  19. package/enums/ChangeOperation.md +4 -4
  20. package/enums/DataType.md +5 -5
  21. package/interfaces/DUActionInterceptor.md +1 -1
  22. package/interfaces/LoadDataRequest.md +17 -5
  23. package/interfaces/LoadDataResponse.md +8 -2
  24. package/interfaces/PageRequest.md +3 -3
  25. package/interfaces/PaginationInfo.md +17 -5
  26. package/interfaces/QuickFilter.md +2 -2
  27. package/interfaces/Record.md +2 -2
  28. package/interfaces/SavedRecord.md +3 -3
  29. package/interfaces/WaitingChange.md +3 -3
  30. package/modules/MaskFormatter.md +2 -2
  31. package/package.json +1 -1
package/classes/ApplicationContext.md CHANGED
@@ -2,6 +2,9 @@
2
2
 
3
3
  # Class: ApplicationContext
4
4
 
5
+ `ApplicationContext`: Utilizado para manipulação do contexto.
6
+ - Evitar uso da classe sem alinhamento com a arquitetura devido ao uso de variáveis globais.
7
+
5
8
  ## Table of contents
6
9
 
7
10
  ### Constructors
@@ -26,19 +29,23 @@
26
29
 
27
30
  ▸ `Static` **getContextValue**(`key`): `any`
28
31
 
32
+ Obtém informação específica do contexto.
33
+
29
34
  #### Parameters
30
35
 
31
- | Name | Type |
32
- | :------ | :------ |
33
- | `key` | `string` |
36
+ | Name | Type | Description |
37
+ | :------ | :------ | :------ |
38
+ | `key` | `string` | Chave do contexto desejada. |
34
39
 
35
40
  #### Returns
36
41
 
37
42
  `any`
38
43
 
44
+ - Informação do contexto desejado.
45
+
39
46
  #### Defined in
40
47
 
41
- src/utils/ApplicationContext.ts:3
48
+ src/utils/ApplicationContext.ts:13
42
49
 
43
50
  ___
44
51
 
@@ -46,13 +53,18 @@ ___
46
53
 
47
54
  ▸ `Static` `Private` **getCtx**(): `any`
48
55
 
56
+ Obtém o contexto global da aplicação sankhyacore.
57
+ - Esse contexto pode ser entendido como um ponto de coesão para atores que não se conhecem poderem trocar informação. Assim, o código x busca por um possível valor no contexto. Se essa informação estiver lá, ele reage de certa forma. O código Y, sabe dessa necessidade mas não consegue passar essa informação diretamente, então atribui o valor ao contexto.
58
+
49
59
  #### Returns
50
60
 
51
61
  `any`
52
62
 
63
+ - Objeto com as propriedades da variável global ___snkcore___ctx___.
64
+
53
65
  #### Defined in
54
66
 
55
- src/utils/ApplicationContext.ts:11
67
+ src/utils/ApplicationContext.ts:32
56
68
 
57
69
  ___
58
70
 
@@ -60,12 +72,14 @@ ___
60
72
 
61
73
  ▸ `Static` **setContextValue**(`key`, `value`): `any`
62
74
 
75
+ Aplica informação no contexto.
76
+
63
77
  #### Parameters
64
78
 
65
- | Name | Type |
66
- | :------ | :------ |
67
- | `key` | `string` |
68
- | `value` | `any` |
79
+ | Name | Type | Description |
80
+ | :------ | :------ | :------ |
81
+ | `key` | `string` | Identificador do contexto. |
82
+ | `value` | `any` | Informação a ser inserida no contexto. |
69
83
 
70
84
  #### Returns
71
85
 
@@ -73,4 +87,4 @@ ___
73
87
 
74
88
  #### Defined in
75
89
 
76
- src/utils/ApplicationContext.ts:7
90
+ src/utils/ApplicationContext.ts:23
package/classes/ArrayUtils.md CHANGED
@@ -2,6 +2,8 @@
2
2
 
3
3
  # Class: ArrayUtils
4
4
 
5
+ `ArrayUtils`: Utilitário com a responsabilidade de manipular Arrays.
6
+
5
7
  ## Table of contents
6
8
 
7
9
  ### Constructors
@@ -32,20 +34,20 @@ Filtra um array a partir de um critério textual.
32
34
 
33
35
  | Name | Type | Default value | Description |
34
36
  | :------ | :------ | :------ | :------ |
35
- | `argument` | `string` | `undefined` | Texto a ser usado no filtro |
36
- | `originalArray` | `any`[] | `undefined` | Array no formato original |
37
+ | `argument` | `string` | `undefined` | Texto a ser usado no filtro. |
38
+ | `originalArray` | `any`[] | `undefined` | Array no formato original. |
37
39
  | `alphabeticalSorting` | `boolean` | `true` | Determina se o resultado deve ser ordenado ou mantido na ordem original. Por padrão ordena. |
38
- | `fieldName` | `string` | `"label"` | Caso o objeto deva ser filtrado por um campo diferente de "label", pode-se usar esse parâmetro |
40
+ | `fieldName` | `string` | `"label"` | Caso o objeto deva ser filtrado por um campo diferente de "label", pode-se usar esse parâmetro. |
39
41
 
40
42
  #### Returns
41
43
 
42
44
  `any`[]
43
45
 
44
- Um array filtrado e ordenado conforme necessidade. Se "argument" for omitido, ou nulo, o array original é retornado.
46
+ - Um array filtrado e ordenado conforme necessidade..
45
47
 
46
48
  #### Defined in
47
49
 
48
- src/utils/ArrayUtils.ts:13
50
+ src/utils/ArrayUtils.ts:15
49
51
 
50
52
  ___
51
53
 
@@ -53,19 +55,23 @@ ___
53
55
 
54
56
  ▸ `Static` `Private` **normalizeSearchString**(`original`): `string`
55
57
 
58
+ Converte texto para caixa alta e substitui caracteres acentuados.
59
+
56
60
  #### Parameters
57
61
 
58
- | Name | Type |
59
- | :------ | :------ |
60
- | `original` | `string` |
62
+ | Name | Type | Description |
63
+ | :------ | :------ | :------ |
64
+ | `original` | `string` | Texto a ser convertido. |
61
65
 
62
66
  #### Returns
63
67
 
64
68
  `string`
65
69
 
70
+ - Texto com as letras acentuadas sem os acentos e em caixa alta.
71
+
66
72
  #### Defined in
67
73
 
68
- src/utils/ArrayUtils.ts:25
74
+ src/utils/ArrayUtils.ts:33
69
75
 
70
76
  ___
71
77
 
@@ -73,17 +79,21 @@ ___
73
79
 
74
80
  ▸ `Static` **sortAlphabetically**(`originalArray`, `fieldName?`): `any`[]
75
81
 
82
+ Ordena valores de um array alfabeticamente.
83
+
76
84
  #### Parameters
77
85
 
78
- | Name | Type | Default value |
79
- | :------ | :------ | :------ |
80
- | `originalArray` | `any`[] | `undefined` |
81
- | `fieldName` | `string` | `"label"` |
86
+ | Name | Type | Default value | Description |
87
+ | :------ | :------ | :------ | :------ |
88
+ | `originalArray` | `any`[] | `undefined` | Array a ser ordenado. |
89
+ | `fieldName` | `string` | `"label"` | - |
82
90
 
83
91
  #### Returns
84
92
 
85
93
  `any`[]
86
94
 
95
+ - Array ordenado alfabeticamente..
96
+
87
97
  #### Defined in
88
98
 
89
- src/utils/ArrayUtils.ts:29
99
+ src/utils/ArrayUtils.ts:43
package/classes/Change.md CHANGED
@@ -2,6 +2,8 @@
2
2
 
3
3
  # Class: Change
4
4
 
5
+ `Change`: Dados que representam uma alteração.
6
+
5
7
  ## Table of contents
6
8
 
7
9
  ### Constructors
@@ -10,8 +12,8 @@
10
12
 
11
13
  ### Properties
12
14
 
15
+ - [DataUnit](Change.md#dataunit)
13
16
  - [\_operation](Change.md#_operation)
14
- - [dataUnit](Change.md#dataunit)
15
17
  - [record](Change.md#record)
16
18
  - [sourceId](Change.md#sourceid)
17
19
  - [updatingFields](Change.md#updatingfields)
@@ -31,13 +33,13 @@
31
33
 
32
34
  ### constructor
33
35
 
34
- • **new Change**(`dataUnit`, `record`, `updates`, `operation`, `sourceId?`)
36
+ • **new Change**(`DataUnit`, `record`, `updates`, `operation`, `sourceId?`)
35
37
 
36
38
  #### Parameters
37
39
 
38
40
  | Name | Type |
39
41
  | :------ | :------ |
40
- | `dataUnit` | `string` |
42
+ | `DataUnit` | `string` |
41
43
  | `record` | [`Record`](../interfaces/Record.md) |
42
44
  | `updates` | `any` |
43
45
  | `operation` | [`ChangeOperation`](../enums/ChangeOperation.md) |
@@ -45,27 +47,27 @@
45
47
 
46
48
  #### Defined in
47
49
 
48
- src/dataunit/DataUnit.ts:584
50
+ src/dataunit/DataUnit.ts:1059
49
51
 
50
52
  ## Properties
51
53
 
52
- ### \_operation
54
+ ### DataUnit
53
55
 
54
- • `Private` **\_operation**: [`ChangeOperation`](../enums/ChangeOperation.md)
56
+ • **DataUnit**: `string`
55
57
 
56
58
  #### Defined in
57
59
 
58
- src/dataunit/DataUnit.ts:582
60
+ src/dataunit/DataUnit.ts:1052
59
61
 
60
62
  ___
61
63
 
62
- ### dataUnit
64
+ ### \_operation
63
65
 
64
- • **dataUnit**: `string`
66
+ • `Private` **\_operation**: [`ChangeOperation`](../enums/ChangeOperation.md)
65
67
 
66
68
  #### Defined in
67
69
 
68
- src/dataunit/DataUnit.ts:577
70
+ src/dataunit/DataUnit.ts:1057
69
71
 
70
72
  ___
71
73
 
@@ -75,7 +77,7 @@ ___
75
77
 
76
78
  #### Defined in
77
79
 
78
- src/dataunit/DataUnit.ts:578
80
+ src/dataunit/DataUnit.ts:1053
79
81
 
80
82
  ___
81
83
 
@@ -85,7 +87,7 @@ ___
85
87
 
86
88
  #### Defined in
87
89
 
88
- src/dataunit/DataUnit.ts:579
90
+ src/dataunit/DataUnit.ts:1054
89
91
 
90
92
  ___
91
93
 
@@ -95,7 +97,7 @@ ___
95
97
 
96
98
  #### Defined in
97
99
 
98
- src/dataunit/DataUnit.ts:580
100
+ src/dataunit/DataUnit.ts:1055
99
101
 
100
102
  ## Accessors
101
103
 
@@ -103,13 +105,17 @@ src/dataunit/DataUnit.ts:580
103
105
 
104
106
  • `get` **operation**(): `string`
105
107
 
108
+ Obtém o tipo de operação que está sendo realizada.
109
+
106
110
  #### Returns
107
111
 
108
112
  `string`
109
113
 
114
+ - Ação que está sendo executada.
115
+
110
116
  #### Defined in
111
117
 
112
- src/dataunit/DataUnit.ts:592
118
+ src/dataunit/DataUnit.ts:1074
113
119
 
114
120
  ## Methods
115
121
 
@@ -117,13 +123,17 @@ src/dataunit/DataUnit.ts:592
117
123
 
118
124
  ▸ **isCopy**(): `boolean`
119
125
 
126
+ Retorna se o DataUnit está em uma operação de cópia.
127
+
120
128
  #### Returns
121
129
 
122
130
  `boolean`
123
131
 
132
+ - Verdadeiro se a operação for de cópia.
133
+
124
134
  #### Defined in
125
135
 
126
- src/dataunit/DataUnit.ts:600
136
+ src/dataunit/DataUnit.ts:1096
127
137
 
128
138
  ___
129
139
 
@@ -131,13 +141,17 @@ ___
131
141
 
132
142
  ▸ **isDelete**(): `boolean`
133
143
 
144
+ Retorna se o DataUnit está em uma operação de deleção.
145
+
134
146
  #### Returns
135
147
 
136
148
  `boolean`
137
149
 
150
+ - Verdadeiro se a operação for de deleção.
151
+
138
152
  #### Defined in
139
153
 
140
- src/dataunit/DataUnit.ts:604
154
+ src/dataunit/DataUnit.ts:1107
141
155
 
142
156
  ___
143
157
 
@@ -145,13 +159,17 @@ ___
145
159
 
146
160
  ▸ **isInsert**(): `boolean`
147
161
 
162
+ Retorna se o DataUnit está em uma operação de inserção.
163
+
148
164
  #### Returns
149
165
 
150
166
  `boolean`
151
167
 
168
+ - Verdadeiro se a operação for de inserção.
169
+
152
170
  #### Defined in
153
171
 
154
- src/dataunit/DataUnit.ts:596
172
+ src/dataunit/DataUnit.ts:1085
155
173
 
156
174
  ___
157
175
 
@@ -159,10 +177,14 @@ ___
159
177
 
160
178
  ▸ **isUpdate**(): `boolean`
161
179
 
180
+ Retorna se o DataUnit está em uma operação de atualização.
181
+
162
182
  #### Returns
163
183
 
164
184
  `boolean`
165
185
 
186
+ - Verdadeiro se a operação for de atualização.
187
+
166
188
  #### Defined in
167
189
 
168
- src/dataunit/DataUnit.ts:608
190
+ src/dataunit/DataUnit.ts:1118