@sankhyalabs/core-docs 0.0.0-feat-dev-KB-42648-2.0 → 0.0.0-feat-dev-KB-46474.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 (18) hide show
  1. package/classes/Change.md +11 -11
  2. package/classes/DataUnit.md +128 -138
  3. package/classes/MaskFormatter.md +9 -13
  4. package/classes/ObjectUtils.md +76 -0
  5. package/classes/SelectionInfo.md +15 -29
  6. package/enumerations/ChangeOperation.md +4 -4
  7. package/enumerations/SelectionMode.md +2 -2
  8. package/interfaces/DUActionInterceptor.md +1 -1
  9. package/interfaces/LoadDataRequest.md +1 -1
  10. package/interfaces/PageRequest.md +3 -3
  11. package/interfaces/QuickFilter.md +3 -3
  12. package/interfaces/Record.md +4 -4
  13. package/interfaces/SavedRecord.md +5 -5
  14. package/interfaces/WaitingChange.md +3 -3
  15. package/namespaces/MaskFormatter/type-aliases/MaskCharacter.md +1 -1
  16. package/namespaces/MaskFormatter/variables/MaskCharacter.md +1 -1
  17. package/package.json +1 -1
  18. 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/ObjectUtils.md CHANGED
@@ -76,6 +76,82 @@ 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
+
79
155
  ### objectToString()
80
156
 
81
157
  > `static` **objectToString**(`data`): `string`
package/classes/SelectionInfo.md CHANGED
@@ -30,7 +30,7 @@
30
30
 
31
31
  #### Source
32
32
 
33
- src/dataunit/DataUnit.ts:1948
33
+ src/dataunit/DataUnit.ts:1925
34
34
 
35
35
  ## Properties
36
36
 
@@ -40,7 +40,7 @@ src/dataunit/DataUnit.ts:1948
40
40
 
41
41
  #### Source
42
42
 
43
- src/dataunit/DataUnit.ts:1945
43
+ src/dataunit/DataUnit.ts:1919
44
44
 
45
45
  ***
46
46
 
@@ -50,7 +50,7 @@ src/dataunit/DataUnit.ts:1945
50
50
 
51
51
  #### Source
52
52
 
53
- src/dataunit/DataUnit.ts:1946
53
+ src/dataunit/DataUnit.ts:1921
54
54
 
55
55
  ***
56
56
 
@@ -60,21 +60,7 @@ src/dataunit/DataUnit.ts:1946
60
60
 
61
61
  #### Source
62
62
 
63
- src/dataunit/DataUnit.ts:1942
64
-
65
- ***
66
-
67
- ### getAllRecords()?
68
-
69
- > `optional` **getAllRecords**: () => `undefined` \| `Promise`\<[`Record`](../interfaces/Record.md)[]\>
70
-
71
- #### Returns
72
-
73
- `undefined` \| `Promise`\<[`Record`](../interfaces/Record.md)[]\>
74
-
75
- #### Source
76
-
77
- src/dataunit/DataUnit.ts:1944
63
+ src/dataunit/DataUnit.ts:1922
78
64
 
79
65
  ***
80
66
 
@@ -84,7 +70,7 @@ src/dataunit/DataUnit.ts:1944
84
70
 
85
71
  #### Source
86
72
 
87
- src/dataunit/DataUnit.ts:1941
73
+ src/dataunit/DataUnit.ts:1920
88
74
 
89
75
  ***
90
76
 
@@ -94,7 +80,7 @@ src/dataunit/DataUnit.ts:1941
94
80
 
95
81
  #### Source
96
82
 
97
- src/dataunit/DataUnit.ts:1943
83
+ src/dataunit/DataUnit.ts:1923
98
84
 
99
85
  ## Accessors
100
86
 
@@ -108,35 +94,35 @@ src/dataunit/DataUnit.ts:1943
108
94
 
109
95
  #### Source
110
96
 
111
- src/dataunit/DataUnit.ts:1983
97
+ src/dataunit/DataUnit.ts:1950
112
98
 
113
99
  ***
114
100
 
115
101
  ### recordIds
116
102
 
117
- > `get` **recordIds**(): `undefined` \| `string`[] \| `Promise`\<`string`[]\>
103
+ > `get` **recordIds**(): `undefined` \| `string`[]
118
104
 
119
105
  #### Returns
120
106
 
121
- `undefined` \| `string`[] \| `Promise`\<`string`[]\>
107
+ `undefined` \| `string`[]
122
108
 
123
109
  #### Source
124
110
 
125
- src/dataunit/DataUnit.ts:1966
111
+ src/dataunit/DataUnit.ts:1940
126
112
 
127
113
  ***
128
114
 
129
115
  ### records
130
116
 
131
- > `get` **records**(): `undefined` \| [`Record`](../interfaces/Record.md)[] \| `Promise`\<[`Record`](../interfaces/Record.md)[]\>
117
+ > `get` **records**(): `undefined` \| [`Record`](../interfaces/Record.md)[]
132
118
 
133
119
  #### Returns
134
120
 
135
- `undefined` \| [`Record`](../interfaces/Record.md)[] \| `Promise`\<[`Record`](../interfaces/Record.md)[]\>
121
+ `undefined` \| [`Record`](../interfaces/Record.md)[]
136
122
 
137
123
  #### Source
138
124
 
139
- src/dataunit/DataUnit.ts:1956
125
+ src/dataunit/DataUnit.ts:1933
140
126
 
141
127
  ## Methods
142
128
 
@@ -150,7 +136,7 @@ src/dataunit/DataUnit.ts:1956
150
136
 
151
137
  #### Source
152
138
 
153
- src/dataunit/DataUnit.ts:1990
139
+ src/dataunit/DataUnit.ts:1957
154
140
 
155
141
  ***
156
142
 
@@ -164,4 +150,4 @@ src/dataunit/DataUnit.ts:1990
164
150
 
165
151
  #### Source
166
152
 
167
- src/dataunit/DataUnit.ts:1994
153
+ src/dataunit/DataUnit.ts:1961
package/enumerations/ChangeOperation.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1827
17
+ src/dataunit/DataUnit.ts:1805
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1827
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1829
27
+ src/dataunit/DataUnit.ts:1807
28
28
 
29
29
  ***
30
30
 
@@ -34,7 +34,7 @@ src/dataunit/DataUnit.ts:1829
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1826
37
+ src/dataunit/DataUnit.ts:1804
38
38
 
39
39
  ***
40
40
 
@@ -44,4 +44,4 @@ src/dataunit/DataUnit.ts:1826
44
44
 
45
45
  #### Source
46
46
 
47
- src/dataunit/DataUnit.ts:1828
47
+ src/dataunit/DataUnit.ts:1806
package/enumerations/SelectionMode.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1935
17
+ src/dataunit/DataUnit.ts:1913
18
18
 
19
19
  ***
20
20
 
@@ -24,4 +24,4 @@ src/dataunit/DataUnit.ts:1935
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1936
27
+ src/dataunit/DataUnit.ts:1914
package/interfaces/DUActionInterceptor.md CHANGED
@@ -22,4 +22,4 @@
22
22
 
23
23
  #### Source
24
24
 
25
- src/dataunit/DataUnit.ts:1810
25
+ src/dataunit/DataUnit.ts:1788
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:1915
17
+ src/dataunit/DataUnit.ts:1893
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1915
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1916
27
+ src/dataunit/DataUnit.ts:1894
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1916
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1917
37
+ src/dataunit/DataUnit.ts:1895
package/interfaces/QuickFilter.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1922
17
+ src/dataunit/DataUnit.ts:1900
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1922
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1923
27
+ src/dataunit/DataUnit.ts:1901
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1923
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1921
37
+ src/dataunit/DataUnit.ts:1899
package/interfaces/Record.md CHANGED
@@ -22,7 +22,7 @@
22
22
 
23
23
  #### Source
24
24
 
25
- src/dataunit/DataUnit.ts:1817
25
+ src/dataunit/DataUnit.ts:1795
26
26
 
27
27
  ***
28
28
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1817
32
32
 
33
33
  #### Source
34
34
 
35
- src/dataunit/DataUnit.ts:1816
35
+ src/dataunit/DataUnit.ts:1794
36
36
 
37
37
  ***
38
38
 
@@ -42,7 +42,7 @@ src/dataunit/DataUnit.ts:1816
42
42
 
43
43
  #### Source
44
44
 
45
- src/dataunit/DataUnit.ts:1814
45
+ src/dataunit/DataUnit.ts:1792
46
46
 
47
47
  ***
48
48
 
@@ -52,4 +52,4 @@ src/dataunit/DataUnit.ts:1814
52
52
 
53
53
  #### Source
54
54
 
55
- src/dataunit/DataUnit.ts:1815
55
+ src/dataunit/DataUnit.ts:1793
package/interfaces/SavedRecord.md CHANGED
@@ -18,7 +18,7 @@
18
18
 
19
19
  #### Source
20
20
 
21
- src/dataunit/DataUnit.ts:1822
21
+ src/dataunit/DataUnit.ts:1800
22
22
 
23
23
  ***
24
24
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1822
32
32
 
33
33
  #### Source
34
34
 
35
- src/dataunit/DataUnit.ts:1817
35
+ src/dataunit/DataUnit.ts:1795
36
36
 
37
37
  ***
38
38
 
@@ -46,7 +46,7 @@ src/dataunit/DataUnit.ts:1817
46
46
 
47
47
  #### Source
48
48
 
49
- src/dataunit/DataUnit.ts:1816
49
+ src/dataunit/DataUnit.ts:1794
50
50
 
51
51
  ***
52
52
 
@@ -60,7 +60,7 @@ src/dataunit/DataUnit.ts:1816
60
60
 
61
61
  #### Source
62
62
 
63
- src/dataunit/DataUnit.ts:1814
63
+ src/dataunit/DataUnit.ts:1792
64
64
 
65
65
  ***
66
66
 
@@ -74,4 +74,4 @@ src/dataunit/DataUnit.ts:1814
74
74
 
75
75
  #### Source
76
76
 
77
- src/dataunit/DataUnit.ts:1815
77
+ src/dataunit/DataUnit.ts:1793
package/interfaces/WaitingChange.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1910
17
+ src/dataunit/DataUnit.ts:1888
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1910
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1911
27
+ src/dataunit/DataUnit.ts:1889
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1911
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1909
37
+ src/dataunit/DataUnit.ts:1887
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.0",
3
+ "version": "0.0.0-feat-dev-KB-46474.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:1999
17
+ src/dataunit/DataUnit.ts:1966