@sankhyalabs/core-docs 0.0.0-hotfix-ga-5531422.0 → 0.0.0-hotfix-rc-KB-68606.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.
@@ -279,6 +279,28 @@ src/repository/indexeddb/IDBRepository.ts:319
279
279
 
280
280
  ***
281
281
 
282
+ ### getFromCache()
283
+
284
+ > **getFromCache**(): `undefined` \| `T`[]
285
+
286
+ Retorna todos os registros que estão em cache no momento
287
+
288
+ #### Returns
289
+
290
+ `undefined` \| `T`[]
291
+
292
+ Todos registros que estão em cache no momento
293
+
294
+ #### Implementation of
295
+
296
+ [`IRepository`](../interfaces/IRepository.md).[`getFromCache`](../interfaces/IRepository.md#getfromcache)
297
+
298
+ #### Source
299
+
300
+ src/repository/indexeddb/IDBRepository.ts:324
301
+
302
+ ***
303
+
282
304
  ### getItemPosition()
283
305
 
284
306
  > `private` **getItemPosition**(`db`, `itemTest`): `Promise`\<`number`\>
@@ -129,7 +129,7 @@ src/utils/MaskFormatter.ts:55
129
129
 
130
130
  #### Source
131
131
 
132
- src/utils/MaskFormatter.ts:375
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:389
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:300
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:281
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:352
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:329
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:101
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:118
312
+ src/utils/MaskFormatter.ts:122
@@ -76,6 +76,99 @@ src/utils/ObjectUtils.ts:84
76
76
 
77
77
  ***
78
78
 
79
+ ### getComparableProp()
80
+
81
+ > `static` `private` **getComparableProp**(`value`, `propToCompare`): `boolean`
82
+
83
+ #### Parameters
84
+
85
+ • **value**: `any`
86
+
87
+ • **propToCompare**: `string`= `"value"`
88
+
89
+ #### Returns
90
+
91
+ `boolean`
92
+
93
+ #### Source
94
+
95
+ src/utils/ObjectUtils.ts:106
96
+
97
+ ***
98
+
99
+ ### getProp()
100
+
101
+ > `static` **getProp**(`obj`, `keyPath`): `undefined` \| `Record`\<`string`, `any`\>
102
+
103
+ Busca a propriedade de um objeto baseado em seu caminho.
104
+
105
+ #### Parameters
106
+
107
+ • **obj**: `Record`\<`string`, `any`\>
108
+
109
+ Objeto a ser verificado.
110
+
111
+ • **keyPath**: `string`
112
+
113
+ Caminho da propriedade a ser buscada.
114
+
115
+ #### Returns
116
+
117
+ `undefined` \| `Record`\<`string`, `any`\>
118
+
119
+ - O valor da propriedade caso ela exista.
120
+
121
+ #### Source
122
+
123
+ src/utils/ObjectUtils.ts:140
124
+
125
+ ***
126
+
127
+ ### hasEquivalentProps()
128
+
129
+ > `static` **hasEquivalentProps**(`obj1`, `obj2`, `propToCompare`): `boolean`
130
+
131
+ Compara se o valor de dois items são equivalentes.
132
+ Comparando tanto o valor do item em si, quanto sua propriedade "value"
133
+
134
+ #### Parameters
135
+
136
+ • **obj1**: `any`
137
+
138
+ Objeto a ser comparado.
139
+
140
+ • **obj2**: `any`
141
+
142
+ Objeto a ser comparado.
143
+
144
+ • **propToCompare**: `string`= `"value"`
145
+
146
+ propriedade que deve ser comparada.
147
+
148
+ #### Returns
149
+
150
+ `boolean`
151
+
152
+ - Se o objeto 1 é equivalente ao objeto 2.
153
+
154
+ *
155
+
156
+ #### Examples
157
+
158
+ ```ts
159
+ hasEquivalentProps('123', {value: '123', label: teste}, 'value') | Retorna: true
160
+ ```
161
+
162
+ ```ts
163
+ hasEquivalentProps('xpto', {value: '123', label: teste}, 'propName') | Retorna: false
164
+ ```
165
+
166
+ #### Source
167
+
168
+ src/utils/ObjectUtils.ts:102
169
+
170
+ ***
171
+
79
172
  ### isEmpty()
80
173
 
81
174
  > `static` **isEmpty**(`obj`): `boolean`
@@ -96,7 +189,7 @@ Objeto a ser verificado.
96
189
 
97
190
  #### Source
98
191
 
99
- src/utils/ObjectUtils.ts:94
192
+ src/utils/ObjectUtils.ts:119
100
193
 
101
194
  ***
102
195
 
@@ -120,7 +213,7 @@ Objeto a ser verificado.
120
213
 
121
214
  #### Source
122
215
 
123
- src/utils/ObjectUtils.ts:104
216
+ src/utils/ObjectUtils.ts:129
124
217
 
125
218
  ***
126
219
 
@@ -30,7 +30,7 @@
30
30
 
31
31
  #### Source
32
32
 
33
- src/dataunit/DataUnit.ts:1960
33
+ src/dataunit/DataUnit.ts:1975
34
34
 
35
35
  ## Properties
36
36
 
@@ -40,7 +40,7 @@ src/dataunit/DataUnit.ts:1960
40
40
 
41
41
  #### Source
42
42
 
43
- src/dataunit/DataUnit.ts:1954
43
+ src/dataunit/DataUnit.ts:1972
44
44
 
45
45
  ***
46
46
 
@@ -50,7 +50,7 @@ src/dataunit/DataUnit.ts:1954
50
50
 
51
51
  #### Source
52
52
 
53
- src/dataunit/DataUnit.ts:1956
53
+ src/dataunit/DataUnit.ts:1973
54
54
 
55
55
  ***
56
56
 
@@ -60,7 +60,21 @@ src/dataunit/DataUnit.ts:1956
60
60
 
61
61
  #### Source
62
62
 
63
- src/dataunit/DataUnit.ts:1957
63
+ src/dataunit/DataUnit.ts:1969
64
+
65
+ ***
66
+
67
+ ### getAllRecords()?
68
+
69
+ > `optional` **getAllRecords**: () => `undefined` \| [`Record`](../interfaces/Record.md)[]
70
+
71
+ #### Returns
72
+
73
+ `undefined` \| [`Record`](../interfaces/Record.md)[]
74
+
75
+ #### Source
76
+
77
+ src/dataunit/DataUnit.ts:1971
64
78
 
65
79
  ***
66
80
 
@@ -70,7 +84,7 @@ src/dataunit/DataUnit.ts:1957
70
84
 
71
85
  #### Source
72
86
 
73
- src/dataunit/DataUnit.ts:1955
87
+ src/dataunit/DataUnit.ts:1968
74
88
 
75
89
  ***
76
90
 
@@ -80,7 +94,7 @@ src/dataunit/DataUnit.ts:1955
80
94
 
81
95
  #### Source
82
96
 
83
- src/dataunit/DataUnit.ts:1958
97
+ src/dataunit/DataUnit.ts:1970
84
98
 
85
99
  ## Accessors
86
100
 
@@ -94,7 +108,7 @@ src/dataunit/DataUnit.ts:1958
94
108
 
95
109
  #### Source
96
110
 
97
- src/dataunit/DataUnit.ts:1985
111
+ src/dataunit/DataUnit.ts:2003
98
112
 
99
113
  ***
100
114
 
@@ -108,7 +122,7 @@ src/dataunit/DataUnit.ts:1985
108
122
 
109
123
  #### Source
110
124
 
111
- src/dataunit/DataUnit.ts:1975
125
+ src/dataunit/DataUnit.ts:1993
112
126
 
113
127
  ***
114
128
 
@@ -122,7 +136,7 @@ src/dataunit/DataUnit.ts:1975
122
136
 
123
137
  #### Source
124
138
 
125
- src/dataunit/DataUnit.ts:1968
139
+ src/dataunit/DataUnit.ts:1983
126
140
 
127
141
  ## Methods
128
142
 
@@ -136,7 +150,7 @@ src/dataunit/DataUnit.ts:1968
136
150
 
137
151
  #### Source
138
152
 
139
- src/dataunit/DataUnit.ts:1992
153
+ src/dataunit/DataUnit.ts:2010
140
154
 
141
155
  ***
142
156
 
@@ -150,4 +164,4 @@ src/dataunit/DataUnit.ts:1992
150
164
 
151
165
  #### Source
152
166
 
153
- src/dataunit/DataUnit.ts:1996
167
+ src/dataunit/DataUnit.ts:2014
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1840
17
+ src/dataunit/DataUnit.ts:1854
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1840
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1842
27
+ src/dataunit/DataUnit.ts:1856
28
28
 
29
29
  ***
30
30
 
@@ -34,7 +34,7 @@ src/dataunit/DataUnit.ts:1842
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1839
37
+ src/dataunit/DataUnit.ts:1853
38
38
 
39
39
  ***
40
40
 
@@ -44,4 +44,4 @@ src/dataunit/DataUnit.ts:1839
44
44
 
45
45
  #### Source
46
46
 
47
- src/dataunit/DataUnit.ts:1841
47
+ src/dataunit/DataUnit.ts:1855
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1948
17
+ src/dataunit/DataUnit.ts:1962
18
18
 
19
19
  ***
20
20
 
@@ -24,4 +24,4 @@ src/dataunit/DataUnit.ts:1948
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1949
27
+ src/dataunit/DataUnit.ts:1963
package/globals.md CHANGED
@@ -49,7 +49,6 @@
49
49
  - [RequestMetadata](classes/RequestMetadata.md)
50
50
  - [SearchUtils](classes/SearchUtils.md)
51
51
  - [SelectionInfo](classes/SelectionInfo.md)
52
- - [ServiceCanceledException](classes/ServiceCanceledException.md)
53
52
  - [SkwHttpProvider](classes/SkwHttpProvider.md)
54
53
  - [StringUtils](classes/StringUtils.md)
55
54
  - [TimeFormatter](classes/TimeFormatter.md)
@@ -22,4 +22,4 @@
22
22
 
23
23
  #### Source
24
24
 
25
- src/dataunit/DataUnit.ts:1823
25
+ src/dataunit/DataUnit.ts:1837
@@ -96,6 +96,24 @@ src/repository/IRepository.ts:23
96
96
 
97
97
  ***
98
98
 
99
+ ### getFromCache()
100
+
101
+ > **getFromCache**(): `undefined` \| `T`[]
102
+
103
+ Retorna todos os registros que estão em cache no momento
104
+
105
+ #### Returns
106
+
107
+ `undefined` \| `T`[]
108
+
109
+ Todos registros que estão em cache no momento
110
+
111
+ #### Source
112
+
113
+ src/repository/IRepository.ts:88
114
+
115
+ ***
116
+
99
117
  ### insert()
100
118
 
101
119
  > **insert**(`itemReference`, `items`): `Promise`\<`void`\>
@@ -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
 
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1928
17
+ src/dataunit/DataUnit.ts:1942
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1928
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1929
27
+ src/dataunit/DataUnit.ts:1943
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1929
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1930
37
+ src/dataunit/DataUnit.ts:1944
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1935
17
+ src/dataunit/DataUnit.ts:1949
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1935
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1936
27
+ src/dataunit/DataUnit.ts:1950
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1936
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1934
37
+ src/dataunit/DataUnit.ts:1948
@@ -22,7 +22,7 @@
22
22
 
23
23
  #### Source
24
24
 
25
- src/dataunit/DataUnit.ts:1830
25
+ src/dataunit/DataUnit.ts:1844
26
26
 
27
27
  ***
28
28
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1830
32
32
 
33
33
  #### Source
34
34
 
35
- src/dataunit/DataUnit.ts:1829
35
+ src/dataunit/DataUnit.ts:1843
36
36
 
37
37
  ***
38
38
 
@@ -42,7 +42,7 @@ src/dataunit/DataUnit.ts:1829
42
42
 
43
43
  #### Source
44
44
 
45
- src/dataunit/DataUnit.ts:1827
45
+ src/dataunit/DataUnit.ts:1841
46
46
 
47
47
  ***
48
48
 
@@ -52,4 +52,4 @@ src/dataunit/DataUnit.ts:1827
52
52
 
53
53
  #### Source
54
54
 
55
- src/dataunit/DataUnit.ts:1828
55
+ src/dataunit/DataUnit.ts:1842
@@ -18,7 +18,7 @@
18
18
 
19
19
  #### Source
20
20
 
21
- src/dataunit/DataUnit.ts:1835
21
+ src/dataunit/DataUnit.ts:1849
22
22
 
23
23
  ***
24
24
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1835
32
32
 
33
33
  #### Source
34
34
 
35
- src/dataunit/DataUnit.ts:1830
35
+ src/dataunit/DataUnit.ts:1844
36
36
 
37
37
  ***
38
38
 
@@ -46,7 +46,7 @@ src/dataunit/DataUnit.ts:1830
46
46
 
47
47
  #### Source
48
48
 
49
- src/dataunit/DataUnit.ts:1829
49
+ src/dataunit/DataUnit.ts:1843
50
50
 
51
51
  ***
52
52
 
@@ -60,7 +60,7 @@ src/dataunit/DataUnit.ts:1829
60
60
 
61
61
  #### Source
62
62
 
63
- src/dataunit/DataUnit.ts:1827
63
+ src/dataunit/DataUnit.ts:1841
64
64
 
65
65
  ***
66
66
 
@@ -74,4 +74,4 @@ src/dataunit/DataUnit.ts:1827
74
74
 
75
75
  #### Source
76
76
 
77
- src/dataunit/DataUnit.ts:1828
77
+ src/dataunit/DataUnit.ts:1842
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1923
17
+ src/dataunit/DataUnit.ts:1937
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1923
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1924
27
+ src/dataunit/DataUnit.ts:1938
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1924
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1922
37
+ src/dataunit/DataUnit.ts:1936
@@ -10,4 +10,4 @@
10
10
 
11
11
  ## Source
12
12
 
13
- src/utils/MaskFormatter.ts:166
13
+ src/utils/MaskFormatter.ts:170
@@ -10,4 +10,4 @@
10
10
 
11
11
  ## Source
12
12
 
13
- src/utils/MaskFormatter.ts:166
13
+ src/utils/MaskFormatter.ts:170
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/core-docs",
3
- "version": "0.0.0-hotfix-ga-5531422.0",
3
+ "version": "0.0.0-hotfix-rc-KB-68606.0",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [
@@ -14,4 +14,4 @@
14
14
 
15
15
  ## Source
16
16
 
17
- src/dataunit/DataUnit.ts:2001
17
+ src/dataunit/DataUnit.ts:2019