@sankhyalabs/core-docs 0.0.0-feat-dev-KB-46474.1 → 0.0.0-feat-dev-KB-42648-2.2
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.
- package/classes/Change.md +11 -11
- package/classes/DataUnit.md +286 -154
- package/classes/MaskFormatter.md +13 -9
- package/classes/ObjectUtils.md +0 -76
- package/classes/SelectionInfo.md +61 -22
- package/enumerations/ChangeOperation.md +4 -4
- package/enumerations/SelectionMode.md +2 -2
- package/interfaces/DUActionInterceptor.md +1 -1
- package/interfaces/LoadDataRequest.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/namespaces/MaskFormatter/type-aliases/MaskCharacter.md +1 -1
- package/namespaces/MaskFormatter/variables/MaskCharacter.md +1 -1
- package/package.json +1 -1
- 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:
|
132
|
+
src/utils/MaskFormatter.ts:379
|
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:
|
152
|
+
src/utils/MaskFormatter.ts:393
|
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:
|
182
|
+
src/utils/MaskFormatter.ts:304
|
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:
|
212
|
+
src/utils/MaskFormatter.ts:285
|
213
213
|
|
214
214
|
***
|
215
215
|
|
@@ -219,7 +219,7 @@ src/utils/MaskFormatter.ts:281
|
|
219
219
|
|
220
220
|
#### Source
|
221
221
|
|
222
|
-
src/utils/MaskFormatter.ts:
|
222
|
+
src/utils/MaskFormatter.ts:356
|
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:
|
242
|
+
src/utils/MaskFormatter.ts:333
|
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`): `string`
|
274
|
+
> **format**(`value`, `trimBefore`): `string`
|
275
275
|
|
276
276
|
Formata a string passada baseada na máscara definda pelo atributo mask.
|
277
277
|
|
@@ -281,6 +281,10 @@ 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
|
+
|
284
288
|
#### Returns
|
285
289
|
|
286
290
|
`string`
|
@@ -289,7 +293,7 @@ O valor processado de acordo com o padrão.
|
|
289
293
|
|
290
294
|
#### Source
|
291
295
|
|
292
|
-
src/utils/MaskFormatter.ts:
|
296
|
+
src/utils/MaskFormatter.ts:102
|
293
297
|
|
294
298
|
***
|
295
299
|
|
@@ -305,4 +309,4 @@ Prepara a formatação internamente de acordo com o padrão.
|
|
305
309
|
|
306
310
|
#### Source
|
307
311
|
|
308
|
-
src/utils/MaskFormatter.ts:
|
312
|
+
src/utils/MaskFormatter.ts:122
|
package/classes/ObjectUtils.md
CHANGED
@@ -76,82 +76,6 @@ src/utils/ObjectUtils.ts:84
|
|
76
76
|
|
77
77
|
***
|
78
78
|
|
79
|
-
### getProp()
|
80
|
-
|
81
|
-
> `static` **getProp**(`obj`, `keyPath`): `Record`\<`string`, `any`\>
|
82
|
-
|
83
|
-
Busca a propriedade de um objeto baseado em seu caminho.
|
84
|
-
|
85
|
-
#### Parameters
|
86
|
-
|
87
|
-
• **obj**: `Record`\<`string`, `any`\>
|
88
|
-
|
89
|
-
Objeto a ser verificado.
|
90
|
-
|
91
|
-
• **keyPath**: `string`
|
92
|
-
|
93
|
-
Caminho da propriedade a ser buscada.
|
94
|
-
|
95
|
-
#### Returns
|
96
|
-
|
97
|
-
`Record`\<`string`, `any`\>
|
98
|
-
|
99
|
-
- O valor da propriedade caso ela exista.
|
100
|
-
|
101
|
-
#### Source
|
102
|
-
|
103
|
-
src/utils/ObjectUtils.ts:115
|
104
|
-
|
105
|
-
***
|
106
|
-
|
107
|
-
### isEmpty()
|
108
|
-
|
109
|
-
> `static` **isEmpty**(`obj`): `boolean`
|
110
|
-
|
111
|
-
Verifica se o objeto está vazio (sem atributos).
|
112
|
-
|
113
|
-
#### Parameters
|
114
|
-
|
115
|
-
• **obj**: `object`
|
116
|
-
|
117
|
-
Objeto a ser verificado.
|
118
|
-
|
119
|
-
#### Returns
|
120
|
-
|
121
|
-
`boolean`
|
122
|
-
|
123
|
-
- True caso o objeto esteja vazio.
|
124
|
-
|
125
|
-
#### Source
|
126
|
-
|
127
|
-
src/utils/ObjectUtils.ts:94
|
128
|
-
|
129
|
-
***
|
130
|
-
|
131
|
-
### isNotEmpty()
|
132
|
-
|
133
|
-
> `static` **isNotEmpty**(`obj`): `boolean`
|
134
|
-
|
135
|
-
Verifica se o objeto NÃO está vazio (sem atributos).
|
136
|
-
|
137
|
-
#### Parameters
|
138
|
-
|
139
|
-
• **obj**: `object`
|
140
|
-
|
141
|
-
Objeto a ser verificado.
|
142
|
-
|
143
|
-
#### Returns
|
144
|
-
|
145
|
-
`boolean`
|
146
|
-
|
147
|
-
- True caso o objeto NÃO esteja vazio
|
148
|
-
|
149
|
-
#### Source
|
150
|
-
|
151
|
-
src/utils/ObjectUtils.ts:104
|
152
|
-
|
153
|
-
***
|
154
|
-
|
155
79
|
### objectToString()
|
156
80
|
|
157
81
|
> `static` **objectToString**(`data`): `string`
|
package/classes/SelectionInfo.md
CHANGED
@@ -4,7 +4,14 @@
|
|
4
4
|
|
5
5
|
[@sankhyalabs/core](../globals.md) / SelectionInfo
|
6
6
|
|
7
|
-
# Class: SelectionInfo
|
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.
|
8
15
|
|
9
16
|
## Constructors
|
10
17
|
|
@@ -30,103 +37,127 @@
|
|
30
37
|
|
31
38
|
#### Source
|
32
39
|
|
33
|
-
src/dataunit/DataUnit.ts:
|
40
|
+
src/dataunit/DataUnit.ts:2031
|
34
41
|
|
35
42
|
## Properties
|
36
43
|
|
37
|
-
###
|
44
|
+
### ~~\_records~~
|
38
45
|
|
39
46
|
> `private` **\_records**: [`Record`](../interfaces/Record.md)[]
|
40
47
|
|
41
48
|
#### Source
|
42
49
|
|
43
|
-
src/dataunit/DataUnit.ts:
|
50
|
+
src/dataunit/DataUnit.ts:2028
|
44
51
|
|
45
52
|
***
|
46
53
|
|
47
|
-
###
|
54
|
+
### ~~\_total?~~
|
48
55
|
|
49
56
|
> `private` `optional` **\_total**: `number`
|
50
57
|
|
51
58
|
#### Source
|
52
59
|
|
53
|
-
src/dataunit/DataUnit.ts:
|
60
|
+
src/dataunit/DataUnit.ts:2029
|
54
61
|
|
55
62
|
***
|
56
63
|
|
57
|
-
### filters
|
64
|
+
### ~~filters?~~
|
58
65
|
|
59
66
|
> `optional` **filters**: [`Filter`](../interfaces/Filter.md)[]
|
60
67
|
|
61
68
|
#### Source
|
62
69
|
|
63
|
-
src/dataunit/DataUnit.ts:
|
70
|
+
src/dataunit/DataUnit.ts:2026
|
64
71
|
|
65
72
|
***
|
66
73
|
|
67
|
-
### mode
|
74
|
+
### ~~mode~~
|
68
75
|
|
69
76
|
> **mode**: [`SelectionMode`](../enumerations/SelectionMode.md)
|
70
77
|
|
71
78
|
#### Source
|
72
79
|
|
73
|
-
src/dataunit/DataUnit.ts:
|
80
|
+
src/dataunit/DataUnit.ts:2025
|
74
81
|
|
75
82
|
***
|
76
83
|
|
77
|
-
### sort
|
84
|
+
### ~~sort?~~
|
78
85
|
|
79
86
|
> `optional` **sort**: [`Sort`](../interfaces/Sort.md)[]
|
80
87
|
|
81
88
|
#### Source
|
82
89
|
|
83
|
-
src/dataunit/DataUnit.ts:
|
90
|
+
src/dataunit/DataUnit.ts:2027
|
84
91
|
|
85
92
|
## Accessors
|
86
93
|
|
87
|
-
### length
|
94
|
+
### ~~length~~
|
88
95
|
|
89
96
|
> `get` **length**(): `number`
|
90
97
|
|
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
|
+
|
91
106
|
#### Returns
|
92
107
|
|
93
108
|
`number`
|
94
109
|
|
95
110
|
#### Source
|
96
111
|
|
97
|
-
src/dataunit/DataUnit.ts:
|
112
|
+
src/dataunit/DataUnit.ts:2083
|
98
113
|
|
99
114
|
***
|
100
115
|
|
101
|
-
### recordIds
|
116
|
+
### ~~recordIds~~
|
102
117
|
|
103
118
|
> `get` **recordIds**(): `undefined` \| `string`[]
|
104
119
|
|
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
|
+
|
105
128
|
#### Returns
|
106
129
|
|
107
130
|
`undefined` \| `string`[]
|
108
131
|
|
109
132
|
#### Source
|
110
133
|
|
111
|
-
src/dataunit/DataUnit.ts:
|
134
|
+
src/dataunit/DataUnit.ts:2063
|
112
135
|
|
113
136
|
***
|
114
137
|
|
115
|
-
### records
|
138
|
+
### ~~records~~
|
116
139
|
|
117
140
|
> `get` **records**(): `undefined` \| [`Record`](../interfaces/Record.md)[]
|
118
141
|
|
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
|
+
|
119
150
|
#### Returns
|
120
151
|
|
121
152
|
`undefined` \| [`Record`](../interfaces/Record.md)[]
|
122
153
|
|
123
154
|
#### Source
|
124
155
|
|
125
|
-
src/dataunit/DataUnit.ts:
|
156
|
+
src/dataunit/DataUnit.ts:2046
|
126
157
|
|
127
158
|
## Methods
|
128
159
|
|
129
|
-
### isAllRecords()
|
160
|
+
### ~~isAllRecords()~~
|
130
161
|
|
131
162
|
> **isAllRecords**(): `boolean`
|
132
163
|
|
@@ -136,18 +167,26 @@ src/dataunit/DataUnit.ts:1933
|
|
136
167
|
|
137
168
|
#### Source
|
138
169
|
|
139
|
-
src/dataunit/DataUnit.ts:
|
170
|
+
src/dataunit/DataUnit.ts:2092
|
140
171
|
|
141
172
|
***
|
142
173
|
|
143
|
-
### isEmpty()
|
174
|
+
### ~~isEmpty()~~
|
144
175
|
|
145
176
|
> **isEmpty**(): `boolean`
|
146
177
|
|
178
|
+
Retorna se a quantidade de registros do DataUnit está vazia.
|
179
|
+
|
147
180
|
#### Returns
|
148
181
|
|
149
182
|
`boolean`
|
150
183
|
|
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
|
+
|
151
190
|
#### Source
|
152
191
|
|
153
|
-
src/dataunit/DataUnit.ts:
|
192
|
+
src/dataunit/DataUnit.ts:2103
|
@@ -14,7 +14,7 @@
|
|
14
14
|
|
15
15
|
#### Source
|
16
16
|
|
17
|
-
src/dataunit/DataUnit.ts:
|
17
|
+
src/dataunit/DataUnit.ts:1905
|
18
18
|
|
19
19
|
***
|
20
20
|
|
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1805
|
|
24
24
|
|
25
25
|
#### Source
|
26
26
|
|
27
|
-
src/dataunit/DataUnit.ts:
|
27
|
+
src/dataunit/DataUnit.ts:1907
|
28
28
|
|
29
29
|
***
|
30
30
|
|
@@ -34,7 +34,7 @@ src/dataunit/DataUnit.ts:1807
|
|
34
34
|
|
35
35
|
#### Source
|
36
36
|
|
37
|
-
src/dataunit/DataUnit.ts:
|
37
|
+
src/dataunit/DataUnit.ts:1904
|
38
38
|
|
39
39
|
***
|
40
40
|
|
@@ -44,4 +44,4 @@ src/dataunit/DataUnit.ts:1804
|
|
44
44
|
|
45
45
|
#### Source
|
46
46
|
|
47
|
-
src/dataunit/DataUnit.ts:
|
47
|
+
src/dataunit/DataUnit.ts:1906
|
@@ -14,7 +14,7 @@
|
|
14
14
|
|
15
15
|
#### Source
|
16
16
|
|
17
|
-
src/dataunit/DataUnit.ts:
|
17
|
+
src/dataunit/DataUnit.ts:1993
|
18
18
|
|
19
19
|
***
|
20
20
|
|
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1893
|
|
24
24
|
|
25
25
|
#### Source
|
26
26
|
|
27
|
-
src/dataunit/DataUnit.ts:
|
27
|
+
src/dataunit/DataUnit.ts:1994
|
28
28
|
|
29
29
|
***
|
30
30
|
|
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1894
|
|
34
34
|
|
35
35
|
#### Source
|
36
36
|
|
37
|
-
src/dataunit/DataUnit.ts:
|
37
|
+
src/dataunit/DataUnit.ts:1995
|
@@ -14,7 +14,7 @@
|
|
14
14
|
|
15
15
|
#### Source
|
16
16
|
|
17
|
-
src/dataunit/DataUnit.ts:
|
17
|
+
src/dataunit/DataUnit.ts:2000
|
18
18
|
|
19
19
|
***
|
20
20
|
|
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1900
|
|
24
24
|
|
25
25
|
#### Source
|
26
26
|
|
27
|
-
src/dataunit/DataUnit.ts:
|
27
|
+
src/dataunit/DataUnit.ts:2001
|
28
28
|
|
29
29
|
***
|
30
30
|
|
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1901
|
|
34
34
|
|
35
35
|
#### Source
|
36
36
|
|
37
|
-
src/dataunit/DataUnit.ts:
|
37
|
+
src/dataunit/DataUnit.ts:1999
|
package/interfaces/Record.md
CHANGED
@@ -22,7 +22,7 @@
|
|
22
22
|
|
23
23
|
#### Source
|
24
24
|
|
25
|
-
src/dataunit/DataUnit.ts:
|
25
|
+
src/dataunit/DataUnit.ts:1895
|
26
26
|
|
27
27
|
***
|
28
28
|
|
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1795
|
|
32
32
|
|
33
33
|
#### Source
|
34
34
|
|
35
|
-
src/dataunit/DataUnit.ts:
|
35
|
+
src/dataunit/DataUnit.ts:1894
|
36
36
|
|
37
37
|
***
|
38
38
|
|
@@ -42,7 +42,7 @@ src/dataunit/DataUnit.ts:1794
|
|
42
42
|
|
43
43
|
#### Source
|
44
44
|
|
45
|
-
src/dataunit/DataUnit.ts:
|
45
|
+
src/dataunit/DataUnit.ts:1892
|
46
46
|
|
47
47
|
***
|
48
48
|
|
@@ -52,4 +52,4 @@ src/dataunit/DataUnit.ts:1792
|
|
52
52
|
|
53
53
|
#### Source
|
54
54
|
|
55
|
-
src/dataunit/DataUnit.ts:
|
55
|
+
src/dataunit/DataUnit.ts:1893
|
@@ -18,7 +18,7 @@
|
|
18
18
|
|
19
19
|
#### Source
|
20
20
|
|
21
|
-
src/dataunit/DataUnit.ts:
|
21
|
+
src/dataunit/DataUnit.ts:1900
|
22
22
|
|
23
23
|
***
|
24
24
|
|
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1800
|
|
32
32
|
|
33
33
|
#### Source
|
34
34
|
|
35
|
-
src/dataunit/DataUnit.ts:
|
35
|
+
src/dataunit/DataUnit.ts:1895
|
36
36
|
|
37
37
|
***
|
38
38
|
|
@@ -46,7 +46,7 @@ src/dataunit/DataUnit.ts:1795
|
|
46
46
|
|
47
47
|
#### Source
|
48
48
|
|
49
|
-
src/dataunit/DataUnit.ts:
|
49
|
+
src/dataunit/DataUnit.ts:1894
|
50
50
|
|
51
51
|
***
|
52
52
|
|
@@ -60,7 +60,7 @@ src/dataunit/DataUnit.ts:1794
|
|
60
60
|
|
61
61
|
#### Source
|
62
62
|
|
63
|
-
src/dataunit/DataUnit.ts:
|
63
|
+
src/dataunit/DataUnit.ts:1892
|
64
64
|
|
65
65
|
***
|
66
66
|
|
@@ -74,4 +74,4 @@ src/dataunit/DataUnit.ts:1792
|
|
74
74
|
|
75
75
|
#### Source
|
76
76
|
|
77
|
-
src/dataunit/DataUnit.ts:
|
77
|
+
src/dataunit/DataUnit.ts:1893
|
@@ -14,7 +14,7 @@
|
|
14
14
|
|
15
15
|
#### Source
|
16
16
|
|
17
|
-
src/dataunit/DataUnit.ts:
|
17
|
+
src/dataunit/DataUnit.ts:1988
|
18
18
|
|
19
19
|
***
|
20
20
|
|
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1888
|
|
24
24
|
|
25
25
|
#### Source
|
26
26
|
|
27
|
-
src/dataunit/DataUnit.ts:
|
27
|
+
src/dataunit/DataUnit.ts:1989
|
28
28
|
|
29
29
|
***
|
30
30
|
|
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1889
|
|
34
34
|
|
35
35
|
#### Source
|
36
36
|
|
37
|
-
src/dataunit/DataUnit.ts:
|
37
|
+
src/dataunit/DataUnit.ts:1987
|
package/package.json
CHANGED