@sankhyalabs/core-docs 0.0.0-hotfix-rc-KB-66847.3 → 0.0.0-hotfix-ga-KB-71417.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,28 +279,6 @@ 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
-
304
282
  ### getItemPosition()
305
283
 
306
284
  > `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: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
@@ -76,99 +76,6 @@ 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
-
172
79
  ### isEmpty()
173
80
 
174
81
  > `static` **isEmpty**(`obj`): `boolean`
@@ -189,7 +96,7 @@ Objeto a ser verificado.
189
96
 
190
97
  #### Source
191
98
 
192
- src/utils/ObjectUtils.ts:119
99
+ src/utils/ObjectUtils.ts:94
193
100
 
194
101
  ***
195
102
 
@@ -213,7 +120,7 @@ Objeto a ser verificado.
213
120
 
214
121
  #### Source
215
122
 
216
- src/utils/ObjectUtils.ts:129
123
+ src/utils/ObjectUtils.ts:104
217
124
 
218
125
  ***
219
126
 
@@ -30,7 +30,7 @@
30
30
 
31
31
  #### Source
32
32
 
33
- src/dataunit/DataUnit.ts:1981
33
+ src/dataunit/DataUnit.ts:1958
34
34
 
35
35
  ## Properties
36
36
 
@@ -40,7 +40,7 @@ src/dataunit/DataUnit.ts:1981
40
40
 
41
41
  #### Source
42
42
 
43
- src/dataunit/DataUnit.ts:1978
43
+ src/dataunit/DataUnit.ts:1952
44
44
 
45
45
  ***
46
46
 
@@ -50,7 +50,7 @@ src/dataunit/DataUnit.ts:1978
50
50
 
51
51
  #### Source
52
52
 
53
- src/dataunit/DataUnit.ts:1979
53
+ src/dataunit/DataUnit.ts:1954
54
54
 
55
55
  ***
56
56
 
@@ -60,21 +60,7 @@ src/dataunit/DataUnit.ts:1979
60
60
 
61
61
  #### Source
62
62
 
63
- src/dataunit/DataUnit.ts:1975
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:1977
63
+ src/dataunit/DataUnit.ts:1955
78
64
 
79
65
  ***
80
66
 
@@ -84,7 +70,7 @@ src/dataunit/DataUnit.ts:1977
84
70
 
85
71
  #### Source
86
72
 
87
- src/dataunit/DataUnit.ts:1974
73
+ src/dataunit/DataUnit.ts:1953
88
74
 
89
75
  ***
90
76
 
@@ -94,7 +80,7 @@ src/dataunit/DataUnit.ts:1974
94
80
 
95
81
  #### Source
96
82
 
97
- src/dataunit/DataUnit.ts:1976
83
+ src/dataunit/DataUnit.ts:1956
98
84
 
99
85
  ## Accessors
100
86
 
@@ -108,7 +94,7 @@ src/dataunit/DataUnit.ts:1976
108
94
 
109
95
  #### Source
110
96
 
111
- src/dataunit/DataUnit.ts:2009
97
+ src/dataunit/DataUnit.ts:1983
112
98
 
113
99
  ***
114
100
 
@@ -122,7 +108,7 @@ src/dataunit/DataUnit.ts:2009
122
108
 
123
109
  #### Source
124
110
 
125
- src/dataunit/DataUnit.ts:1999
111
+ src/dataunit/DataUnit.ts:1973
126
112
 
127
113
  ***
128
114
 
@@ -136,7 +122,7 @@ src/dataunit/DataUnit.ts:1999
136
122
 
137
123
  #### Source
138
124
 
139
- src/dataunit/DataUnit.ts:1989
125
+ src/dataunit/DataUnit.ts:1966
140
126
 
141
127
  ## Methods
142
128
 
@@ -150,7 +136,7 @@ src/dataunit/DataUnit.ts:1989
150
136
 
151
137
  #### Source
152
138
 
153
- src/dataunit/DataUnit.ts:2016
139
+ src/dataunit/DataUnit.ts:1990
154
140
 
155
141
  ***
156
142
 
@@ -164,4 +150,4 @@ src/dataunit/DataUnit.ts:2016
164
150
 
165
151
  #### Source
166
152
 
167
- src/dataunit/DataUnit.ts:2020
153
+ src/dataunit/DataUnit.ts:1994
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1860
17
+ src/dataunit/DataUnit.ts:1838
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1860
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1862
27
+ src/dataunit/DataUnit.ts:1840
28
28
 
29
29
  ***
30
30
 
@@ -34,7 +34,7 @@ src/dataunit/DataUnit.ts:1862
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1859
37
+ src/dataunit/DataUnit.ts:1837
38
38
 
39
39
  ***
40
40
 
@@ -44,4 +44,4 @@ src/dataunit/DataUnit.ts:1859
44
44
 
45
45
  #### Source
46
46
 
47
- src/dataunit/DataUnit.ts:1861
47
+ src/dataunit/DataUnit.ts:1839
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/metadata/UnitMetadata.ts:77
17
+ src/dataunit/metadata/UnitMetadata.ts:78
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/metadata/UnitMetadata.ts:77
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/metadata/UnitMetadata.ts:76
27
+ src/dataunit/metadata/UnitMetadata.ts:77
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/metadata/UnitMetadata.ts:76
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/metadata/UnitMetadata.ts:78
37
+ src/dataunit/metadata/UnitMetadata.ts:79
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1968
17
+ src/dataunit/DataUnit.ts:1946
18
18
 
19
19
  ***
20
20
 
@@ -24,4 +24,4 @@ src/dataunit/DataUnit.ts:1968
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1969
27
+ src/dataunit/DataUnit.ts:1947
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/metadata/UnitMetadata.ts:71
17
+ src/dataunit/metadata/UnitMetadata.ts:72
18
18
 
19
19
  ***
20
20
 
@@ -24,4 +24,4 @@ src/dataunit/metadata/UnitMetadata.ts:71
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/metadata/UnitMetadata.ts:72
27
+ src/dataunit/metadata/UnitMetadata.ts:73
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/metadata/UnitMetadata.ts:88
17
+ src/dataunit/metadata/UnitMetadata.ts:89
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/metadata/UnitMetadata.ts:88
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/metadata/UnitMetadata.ts:84
27
+ src/dataunit/metadata/UnitMetadata.ts:85
28
28
 
29
29
  ***
30
30
 
@@ -34,7 +34,7 @@ src/dataunit/metadata/UnitMetadata.ts:84
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/metadata/UnitMetadata.ts:85
37
+ src/dataunit/metadata/UnitMetadata.ts:86
38
38
 
39
39
  ***
40
40
 
@@ -44,7 +44,7 @@ src/dataunit/metadata/UnitMetadata.ts:85
44
44
 
45
45
  #### Source
46
46
 
47
- src/dataunit/metadata/UnitMetadata.ts:91
47
+ src/dataunit/metadata/UnitMetadata.ts:92
48
48
 
49
49
  ***
50
50
 
@@ -54,7 +54,7 @@ src/dataunit/metadata/UnitMetadata.ts:91
54
54
 
55
55
  #### Source
56
56
 
57
- src/dataunit/metadata/UnitMetadata.ts:87
57
+ src/dataunit/metadata/UnitMetadata.ts:88
58
58
 
59
59
  ***
60
60
 
@@ -64,7 +64,7 @@ src/dataunit/metadata/UnitMetadata.ts:87
64
64
 
65
65
  #### Source
66
66
 
67
- src/dataunit/metadata/UnitMetadata.ts:82
67
+ src/dataunit/metadata/UnitMetadata.ts:83
68
68
 
69
69
  ***
70
70
 
@@ -74,7 +74,7 @@ src/dataunit/metadata/UnitMetadata.ts:82
74
74
 
75
75
  #### Source
76
76
 
77
- src/dataunit/metadata/UnitMetadata.ts:98
77
+ src/dataunit/metadata/UnitMetadata.ts:99
78
78
 
79
79
  ***
80
80
 
@@ -84,7 +84,7 @@ src/dataunit/metadata/UnitMetadata.ts:98
84
84
 
85
85
  #### Source
86
86
 
87
- src/dataunit/metadata/UnitMetadata.ts:83
87
+ src/dataunit/metadata/UnitMetadata.ts:84
88
88
 
89
89
  ***
90
90
 
@@ -94,7 +94,7 @@ src/dataunit/metadata/UnitMetadata.ts:83
94
94
 
95
95
  #### Source
96
96
 
97
- src/dataunit/metadata/UnitMetadata.ts:92
97
+ src/dataunit/metadata/UnitMetadata.ts:93
98
98
 
99
99
  ***
100
100
 
@@ -104,7 +104,7 @@ src/dataunit/metadata/UnitMetadata.ts:92
104
104
 
105
105
  #### Source
106
106
 
107
- src/dataunit/metadata/UnitMetadata.ts:97
107
+ src/dataunit/metadata/UnitMetadata.ts:98
108
108
 
109
109
  ***
110
110
 
@@ -114,7 +114,7 @@ src/dataunit/metadata/UnitMetadata.ts:97
114
114
 
115
115
  #### Source
116
116
 
117
- src/dataunit/metadata/UnitMetadata.ts:96
117
+ src/dataunit/metadata/UnitMetadata.ts:97
118
118
 
119
119
  ***
120
120
 
@@ -124,7 +124,7 @@ src/dataunit/metadata/UnitMetadata.ts:96
124
124
 
125
125
  #### Source
126
126
 
127
- src/dataunit/metadata/UnitMetadata.ts:90
127
+ src/dataunit/metadata/UnitMetadata.ts:91
128
128
 
129
129
  ***
130
130
 
@@ -134,7 +134,7 @@ src/dataunit/metadata/UnitMetadata.ts:90
134
134
 
135
135
  #### Source
136
136
 
137
- src/dataunit/metadata/UnitMetadata.ts:95
137
+ src/dataunit/metadata/UnitMetadata.ts:96
138
138
 
139
139
  ***
140
140
 
@@ -144,7 +144,7 @@ src/dataunit/metadata/UnitMetadata.ts:95
144
144
 
145
145
  #### Source
146
146
 
147
- src/dataunit/metadata/UnitMetadata.ts:93
147
+ src/dataunit/metadata/UnitMetadata.ts:94
148
148
 
149
149
  ***
150
150
 
@@ -154,7 +154,7 @@ src/dataunit/metadata/UnitMetadata.ts:93
154
154
 
155
155
  #### Source
156
156
 
157
- src/dataunit/metadata/UnitMetadata.ts:94
157
+ src/dataunit/metadata/UnitMetadata.ts:95
158
158
 
159
159
  ***
160
160
 
@@ -164,7 +164,7 @@ src/dataunit/metadata/UnitMetadata.ts:94
164
164
 
165
165
  #### Source
166
166
 
167
- src/dataunit/metadata/UnitMetadata.ts:89
167
+ src/dataunit/metadata/UnitMetadata.ts:90
168
168
 
169
169
  ***
170
170
 
@@ -174,4 +174,4 @@ src/dataunit/metadata/UnitMetadata.ts:89
174
174
 
175
175
  #### Source
176
176
 
177
- src/dataunit/metadata/UnitMetadata.ts:86
177
+ src/dataunit/metadata/UnitMetadata.ts:87
@@ -22,4 +22,4 @@
22
22
 
23
23
  #### Source
24
24
 
25
- src/dataunit/DataUnit.ts:1843
25
+ src/dataunit/DataUnit.ts:1821
@@ -34,7 +34,7 @@ src/dataunit/metadata/UnitMetadata.ts:26
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/metadata/UnitMetadata.ts:32
37
+ src/dataunit/metadata/UnitMetadata.ts:33
38
38
 
39
39
  ***
40
40
 
@@ -44,7 +44,7 @@ src/dataunit/metadata/UnitMetadata.ts:32
44
44
 
45
45
  #### Source
46
46
 
47
- src/dataunit/metadata/UnitMetadata.ts:33
47
+ src/dataunit/metadata/UnitMetadata.ts:34
48
48
 
49
49
  ***
50
50
 
@@ -74,7 +74,17 @@ src/dataunit/metadata/UnitMetadata.ts:22
74
74
 
75
75
  #### Source
76
76
 
77
- src/dataunit/metadata/UnitMetadata.ts:34
77
+ src/dataunit/metadata/UnitMetadata.ts:35
78
+
79
+ ***
80
+
81
+ ### primaryKey?
82
+
83
+ > `optional` **primaryKey**: `boolean`
84
+
85
+ #### Source
86
+
87
+ src/dataunit/metadata/UnitMetadata.ts:28
78
88
 
79
89
  ***
80
90
 
@@ -84,7 +94,7 @@ src/dataunit/metadata/UnitMetadata.ts:34
84
94
 
85
95
  #### Source
86
96
 
87
- src/dataunit/metadata/UnitMetadata.ts:31
97
+ src/dataunit/metadata/UnitMetadata.ts:32
88
98
 
89
99
  ***
90
100
 
@@ -94,7 +104,7 @@ src/dataunit/metadata/UnitMetadata.ts:31
94
104
 
95
105
  #### Source
96
106
 
97
- src/dataunit/metadata/UnitMetadata.ts:28
107
+ src/dataunit/metadata/UnitMetadata.ts:29
98
108
 
99
109
  ***
100
110
 
@@ -104,7 +114,7 @@ src/dataunit/metadata/UnitMetadata.ts:28
104
114
 
105
115
  #### Source
106
116
 
107
- src/dataunit/metadata/UnitMetadata.ts:29
117
+ src/dataunit/metadata/UnitMetadata.ts:30
108
118
 
109
119
  ***
110
120
 
@@ -114,7 +124,7 @@ src/dataunit/metadata/UnitMetadata.ts:29
114
124
 
115
125
  #### Source
116
126
 
117
- src/dataunit/metadata/UnitMetadata.ts:30
127
+ src/dataunit/metadata/UnitMetadata.ts:31
118
128
 
119
129
  ***
120
130
 
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/metadata/UnitMetadata.ts:45
17
+ src/dataunit/metadata/UnitMetadata.ts:46
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/metadata/UnitMetadata.ts:45
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/metadata/UnitMetadata.ts:44
27
+ src/dataunit/metadata/UnitMetadata.ts:45
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/metadata/UnitMetadata.ts:44
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/metadata/UnitMetadata.ts:46
37
+ src/dataunit/metadata/UnitMetadata.ts:47
@@ -96,24 +96,6 @@ 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
-
117
99
  ### insert()
118
100
 
119
101
  > **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