@sankhyalabs/core-docs 0.0.0-feat-dev-KB-42648-2.4 → 0.0.0-feat-dev-kb-52609.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 (17) hide show
  1. package/classes/Change.md +11 -11
  2. package/classes/DataUnit.md +177 -287
  3. package/classes/MaskFormatter.md +9 -13
  4. package/classes/SelectionInfo.md +22 -61
  5. package/enumerations/ChangeOperation.md +4 -4
  6. package/enumerations/SelectionMode.md +2 -2
  7. package/interfaces/DUActionInterceptor.md +1 -1
  8. package/interfaces/LoadDataRequest.md +1 -1
  9. package/interfaces/PageRequest.md +3 -3
  10. package/interfaces/QuickFilter.md +3 -3
  11. package/interfaces/Record.md +4 -4
  12. package/interfaces/SavedRecord.md +5 -5
  13. package/interfaces/WaitingChange.md +3 -3
  14. package/namespaces/MaskFormatter/type-aliases/MaskCharacter.md +1 -1
  15. package/namespaces/MaskFormatter/variables/MaskCharacter.md +1 -1
  16. package/package.json +1 -1
  17. package/type-aliases/DataUnitEventOptions.md +1 -1
package/classes/MaskFormatter.md CHANGED
@@ -129,7 +129,7 @@ src/utils/MaskFormatter.ts:55
129
129
 
130
130
  #### Source
131
131
 
132
- src/utils/MaskFormatter.ts:379
132
+ src/utils/MaskFormatter.ts:375
133
133
 
134
134
  ***
135
135
 
@@ -149,7 +149,7 @@ src/utils/MaskFormatter.ts:54
149
149
 
150
150
  #### Source
151
151
 
152
- src/utils/MaskFormatter.ts:393
152
+ src/utils/MaskFormatter.ts:389
153
153
 
154
154
  ***
155
155
 
@@ -179,7 +179,7 @@ src/utils/MaskFormatter.ts:49
179
179
 
180
180
  #### Source
181
181
 
182
- src/utils/MaskFormatter.ts:304
182
+ src/utils/MaskFormatter.ts:300
183
183
 
184
184
  ***
185
185
 
@@ -209,7 +209,7 @@ src/utils/MaskFormatter.ts:52
209
209
 
210
210
  #### Source
211
211
 
212
- src/utils/MaskFormatter.ts:285
212
+ src/utils/MaskFormatter.ts:281
213
213
 
214
214
  ***
215
215
 
@@ -219,7 +219,7 @@ src/utils/MaskFormatter.ts:285
219
219
 
220
220
  #### Source
221
221
 
222
- src/utils/MaskFormatter.ts:356
222
+ src/utils/MaskFormatter.ts:352
223
223
 
224
224
  ***
225
225
 
@@ -239,7 +239,7 @@ src/utils/MaskFormatter.ts:51
239
239
 
240
240
  #### Source
241
241
 
242
- src/utils/MaskFormatter.ts:333
242
+ src/utils/MaskFormatter.ts:329
243
243
 
244
244
  ## Accessors
245
245
 
@@ -271,7 +271,7 @@ src/utils/MaskFormatter.ts:87
271
271
 
272
272
  ### format()
273
273
 
274
- > **format**(`value`, `trimBefore`): `string`
274
+ > **format**(`value`): `string`
275
275
 
276
276
  Formata a string passada baseada na máscara definda pelo atributo mask.
277
277
 
@@ -281,10 +281,6 @@ Formata a string passada baseada na máscara definda pelo atributo mask.
281
281
 
282
282
  Valor a ser formatado.
283
283
 
284
- • **trimBefore**: `boolean`= `false`
285
-
286
- Executa um trim para remover espaços em branco.
287
-
288
284
  #### Returns
289
285
 
290
286
  `string`
@@ -293,7 +289,7 @@ O valor processado de acordo com o padrão.
293
289
 
294
290
  #### Source
295
291
 
296
- src/utils/MaskFormatter.ts:102
292
+ src/utils/MaskFormatter.ts:101
297
293
 
298
294
  ***
299
295
 
@@ -309,4 +305,4 @@ Prepara a formatação internamente de acordo com o padrão.
309
305
 
310
306
  #### Source
311
307
 
312
- src/utils/MaskFormatter.ts:122
308
+ src/utils/MaskFormatter.ts:118
package/classes/SelectionInfo.md CHANGED
@@ -4,14 +4,7 @@
4
4
 
5
5
  [@sankhyalabs/core](../globals.md) / SelectionInfo
6
6
 
7
- # Class: ~~SelectionInfo~~
8
-
9
- ## Deprecated
10
-
11
- - Classe deprecada.
12
- Devido a seleção virtual baseada em critérios e ordenação (ALL_RECORDS), essa
13
- classe foi descontinuado e pode retornar erros no caso da seleção virtual.
14
- Utilizar o AsyncSelectionInfo.
7
+ # Class: SelectionInfo
15
8
 
16
9
  ## Constructors
17
10
 
@@ -37,127 +30,103 @@ Utilizar o AsyncSelectionInfo.
37
30
 
38
31
  #### Source
39
32
 
40
- src/dataunit/DataUnit.ts:2033
33
+ src/dataunit/DataUnit.ts:1941
41
34
 
42
35
  ## Properties
43
36
 
44
- ### ~~\_records~~
37
+ ### \_records
45
38
 
46
39
  > `private` **\_records**: [`Record`](../interfaces/Record.md)[]
47
40
 
48
41
  #### Source
49
42
 
50
- src/dataunit/DataUnit.ts:2030
43
+ src/dataunit/DataUnit.ts:1935
51
44
 
52
45
  ***
53
46
 
54
- ### ~~\_total?~~
47
+ ### \_total?
55
48
 
56
49
  > `private` `optional` **\_total**: `number`
57
50
 
58
51
  #### Source
59
52
 
60
- src/dataunit/DataUnit.ts:2031
53
+ src/dataunit/DataUnit.ts:1937
61
54
 
62
55
  ***
63
56
 
64
- ### ~~filters?~~
57
+ ### filters?
65
58
 
66
59
  > `optional` **filters**: [`Filter`](../interfaces/Filter.md)[]
67
60
 
68
61
  #### Source
69
62
 
70
- src/dataunit/DataUnit.ts:2028
63
+ src/dataunit/DataUnit.ts:1938
71
64
 
72
65
  ***
73
66
 
74
- ### ~~mode~~
67
+ ### mode
75
68
 
76
69
  > **mode**: [`SelectionMode`](../enumerations/SelectionMode.md)
77
70
 
78
71
  #### Source
79
72
 
80
- src/dataunit/DataUnit.ts:2027
73
+ src/dataunit/DataUnit.ts:1936
81
74
 
82
75
  ***
83
76
 
84
- ### ~~sort?~~
77
+ ### sort?
85
78
 
86
79
  > `optional` **sort**: [`Sort`](../interfaces/Sort.md)[]
87
80
 
88
81
  #### Source
89
82
 
90
- src/dataunit/DataUnit.ts:2029
83
+ src/dataunit/DataUnit.ts:1939
91
84
 
92
85
  ## Accessors
93
86
 
94
- ### ~~length~~
87
+ ### length
95
88
 
96
89
  > `get` **length**(): `number`
97
90
 
98
- Retorna a quantidade de registros do DataUnit.
99
-
100
- #### Deprecated
101
-
102
- - Método deprecado.
103
- Devido a seleção virtual baseada em critérios e ordenação (ALL_RECORDS), esse
104
- método foi descontinuado e pode retornar erros no caso da seleção virtual.
105
-
106
91
  #### Returns
107
92
 
108
93
  `number`
109
94
 
110
95
  #### Source
111
96
 
112
- src/dataunit/DataUnit.ts:2085
97
+ src/dataunit/DataUnit.ts:1966
113
98
 
114
99
  ***
115
100
 
116
- ### ~~recordIds~~
101
+ ### recordIds
117
102
 
118
103
  > `get` **recordIds**(): `undefined` \| `string`[]
119
104
 
120
- Retorna os IDs dos registros selecionados.
121
-
122
- #### Deprecated
123
-
124
- - Método deprecado.
125
- Devido a seleção virtual baseada em critérios e ordenação (ALL_RECORDS), esse
126
- método foi descontinuado e pode retornar erros no caso da seleção virtual.
127
-
128
105
  #### Returns
129
106
 
130
107
  `undefined` \| `string`[]
131
108
 
132
109
  #### Source
133
110
 
134
- src/dataunit/DataUnit.ts:2065
111
+ src/dataunit/DataUnit.ts:1956
135
112
 
136
113
  ***
137
114
 
138
- ### ~~records~~
115
+ ### records
139
116
 
140
117
  > `get` **records**(): `undefined` \| [`Record`](../interfaces/Record.md)[]
141
118
 
142
- Busca os registros carregados do DataUnit.
143
-
144
- #### Deprecated
145
-
146
- - Método deprecado.
147
- Devido a seleção virtual baseada em critérios e ordenação (ALL_RECORDS), esse
148
- método foi descontinuado e pode retornar erros no caso da seleção virtual.
149
-
150
119
  #### Returns
151
120
 
152
121
  `undefined` \| [`Record`](../interfaces/Record.md)[]
153
122
 
154
123
  #### Source
155
124
 
156
- src/dataunit/DataUnit.ts:2048
125
+ src/dataunit/DataUnit.ts:1949
157
126
 
158
127
  ## Methods
159
128
 
160
- ### ~~isAllRecords()~~
129
+ ### isAllRecords()
161
130
 
162
131
  > **isAllRecords**(): `boolean`
163
132
 
@@ -167,26 +136,18 @@ src/dataunit/DataUnit.ts:2048
167
136
 
168
137
  #### Source
169
138
 
170
- src/dataunit/DataUnit.ts:2094
139
+ src/dataunit/DataUnit.ts:1973
171
140
 
172
141
  ***
173
142
 
174
- ### ~~isEmpty()~~
143
+ ### isEmpty()
175
144
 
176
145
  > **isEmpty**(): `boolean`
177
146
 
178
- Retorna se a quantidade de registros do DataUnit está vazia.
179
-
180
147
  #### Returns
181
148
 
182
149
  `boolean`
183
150
 
184
- #### Deprecated
185
-
186
- - Método deprecado.
187
- Devido a seleção virtual baseada em critérios e ordenação (ALL_RECORDS), esse
188
- método foi descontinuado e pode retornar erros no caso da seleção virtual.
189
-
190
151
  #### Source
191
152
 
192
- src/dataunit/DataUnit.ts:2105
153
+ src/dataunit/DataUnit.ts:1977
package/enumerations/ChangeOperation.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1907
17
+ src/dataunit/DataUnit.ts:1821
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1907
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1909
27
+ src/dataunit/DataUnit.ts:1823
28
28
 
29
29
  ***
30
30
 
@@ -34,7 +34,7 @@ src/dataunit/DataUnit.ts:1909
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1906
37
+ src/dataunit/DataUnit.ts:1820
38
38
 
39
39
  ***
40
40
 
@@ -44,4 +44,4 @@ src/dataunit/DataUnit.ts:1906
44
44
 
45
45
  #### Source
46
46
 
47
- src/dataunit/DataUnit.ts:1908
47
+ src/dataunit/DataUnit.ts:1822
package/enumerations/SelectionMode.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:2015
17
+ src/dataunit/DataUnit.ts:1929
18
18
 
19
19
  ***
20
20
 
@@ -24,4 +24,4 @@ src/dataunit/DataUnit.ts:2015
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:2016
27
+ src/dataunit/DataUnit.ts:1930
package/interfaces/DUActionInterceptor.md CHANGED
@@ -22,4 +22,4 @@
22
22
 
23
23
  #### Source
24
24
 
25
- src/dataunit/DataUnit.ts:1890
25
+ src/dataunit/DataUnit.ts:1804
package/interfaces/LoadDataRequest.md CHANGED
@@ -96,7 +96,7 @@ src/dataunit/loading/LoadDataRequest.ts:22
96
96
 
97
97
  ### source?
98
98
 
99
- > `optional` **source**: `string`
99
+ > `optional` **source**: `String`
100
100
 
101
101
  De onde partiu o refresh. Por padrão a fonte não é identificada
102
102
 
package/interfaces/PageRequest.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1995
17
+ src/dataunit/DataUnit.ts:1909
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1995
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1996
27
+ src/dataunit/DataUnit.ts:1910
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1996
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1997
37
+ src/dataunit/DataUnit.ts:1911
package/interfaces/QuickFilter.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:2002
17
+ src/dataunit/DataUnit.ts:1916
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:2002
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:2003
27
+ src/dataunit/DataUnit.ts:1917
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:2003
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:2001
37
+ src/dataunit/DataUnit.ts:1915
package/interfaces/Record.md CHANGED
@@ -22,7 +22,7 @@
22
22
 
23
23
  #### Source
24
24
 
25
- src/dataunit/DataUnit.ts:1897
25
+ src/dataunit/DataUnit.ts:1811
26
26
 
27
27
  ***
28
28
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1897
32
32
 
33
33
  #### Source
34
34
 
35
- src/dataunit/DataUnit.ts:1896
35
+ src/dataunit/DataUnit.ts:1810
36
36
 
37
37
  ***
38
38
 
@@ -42,7 +42,7 @@ src/dataunit/DataUnit.ts:1896
42
42
 
43
43
  #### Source
44
44
 
45
- src/dataunit/DataUnit.ts:1894
45
+ src/dataunit/DataUnit.ts:1808
46
46
 
47
47
  ***
48
48
 
@@ -52,4 +52,4 @@ src/dataunit/DataUnit.ts:1894
52
52
 
53
53
  #### Source
54
54
 
55
- src/dataunit/DataUnit.ts:1895
55
+ src/dataunit/DataUnit.ts:1809
package/interfaces/SavedRecord.md CHANGED
@@ -18,7 +18,7 @@
18
18
 
19
19
  #### Source
20
20
 
21
- src/dataunit/DataUnit.ts:1902
21
+ src/dataunit/DataUnit.ts:1816
22
22
 
23
23
  ***
24
24
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1902
32
32
 
33
33
  #### Source
34
34
 
35
- src/dataunit/DataUnit.ts:1897
35
+ src/dataunit/DataUnit.ts:1811
36
36
 
37
37
  ***
38
38
 
@@ -46,7 +46,7 @@ src/dataunit/DataUnit.ts:1897
46
46
 
47
47
  #### Source
48
48
 
49
- src/dataunit/DataUnit.ts:1896
49
+ src/dataunit/DataUnit.ts:1810
50
50
 
51
51
  ***
52
52
 
@@ -60,7 +60,7 @@ src/dataunit/DataUnit.ts:1896
60
60
 
61
61
  #### Source
62
62
 
63
- src/dataunit/DataUnit.ts:1894
63
+ src/dataunit/DataUnit.ts:1808
64
64
 
65
65
  ***
66
66
 
@@ -74,4 +74,4 @@ src/dataunit/DataUnit.ts:1894
74
74
 
75
75
  #### Source
76
76
 
77
- src/dataunit/DataUnit.ts:1895
77
+ src/dataunit/DataUnit.ts:1809
package/interfaces/WaitingChange.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1990
17
+ src/dataunit/DataUnit.ts:1904
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1990
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1991
27
+ src/dataunit/DataUnit.ts:1905
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1991
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1989
37
+ src/dataunit/DataUnit.ts:1903
package/namespaces/MaskFormatter/type-aliases/MaskCharacter.md CHANGED
@@ -10,4 +10,4 @@
10
10
 
11
11
  ## Source
12
12
 
13
- src/utils/MaskFormatter.ts:170
13
+ src/utils/MaskFormatter.ts:166
package/namespaces/MaskFormatter/variables/MaskCharacter.md CHANGED
@@ -10,4 +10,4 @@
10
10
 
11
11
  ## Source
12
12
 
13
- src/utils/MaskFormatter.ts:170
13
+ src/utils/MaskFormatter.ts:166
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/core-docs",
3
- "version": "0.0.0-feat-dev-KB-42648-2.4",
3
+ "version": "0.0.0-feat-dev-kb-52609.0",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [
package/type-aliases/DataUnitEventOptions.md CHANGED
@@ -14,4 +14,4 @@
14
14
 
15
15
  ## Source
16
16
 
17
- src/dataunit/DataUnit.ts:2112
17
+ src/dataunit/DataUnit.ts:1982