@sankhyalabs/core-docs 0.0.0-feat-dev-KB-55365.0 → 0.0.0-feat-dev-KB-34470.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 (20) hide show
  1. package/classes/Change.md +11 -11
  2. package/classes/DataUnit.md +130 -180
  3. package/classes/IDBRepository.md +0 -22
  4. package/classes/MaskFormatter.md +9 -13
  5. package/classes/ObjectUtils.md +28 -0
  6. package/classes/SelectionInfo.md +11 -25
  7. package/enumerations/ChangeOperation.md +4 -4
  8. package/enumerations/SelectionMode.md +2 -2
  9. package/interfaces/DUActionInterceptor.md +1 -1
  10. package/interfaces/IRepository.md +0 -18
  11. package/interfaces/LoadDataRequest.md +1 -1
  12. package/interfaces/PageRequest.md +3 -3
  13. package/interfaces/QuickFilter.md +3 -3
  14. package/interfaces/Record.md +4 -4
  15. package/interfaces/SavedRecord.md +5 -5
  16. package/interfaces/WaitingChange.md +3 -3
  17. package/namespaces/MaskFormatter/type-aliases/MaskCharacter.md +1 -1
  18. package/namespaces/MaskFormatter/variables/MaskCharacter.md +1 -1
  19. package/package.json +1 -1
  20. package/type-aliases/DataUnitEventOptions.md +1 -1
package/classes/IDBRepository.md CHANGED
@@ -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`\>
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,34 @@ src/utils/ObjectUtils.ts:84
76
76
 
77
77
  ***
78
78
 
79
+ ### getProp()
80
+
81
+ > `static` **getProp**(`obj`, `keyPath`): `undefined` \| `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
+ `undefined` \| `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
+
79
107
  ### isEmpty()
80
108
 
81
109
  > `static` **isEmpty**(`obj`): `boolean`
package/classes/SelectionInfo.md CHANGED
@@ -30,7 +30,7 @@
30
30
 
31
31
  #### Source
32
32
 
33
- src/dataunit/DataUnit.ts:1960
33
+ src/dataunit/DataUnit.ts:1925
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:1957
43
+ src/dataunit/DataUnit.ts:1919
44
44
 
45
45
  ***
46
46
 
@@ -50,7 +50,7 @@ src/dataunit/DataUnit.ts:1957
50
50
 
51
51
  #### Source
52
52
 
53
- src/dataunit/DataUnit.ts:1958
53
+ src/dataunit/DataUnit.ts:1921
54
54
 
55
55
  ***
56
56
 
@@ -60,21 +60,7 @@ src/dataunit/DataUnit.ts:1958
60
60
 
61
61
  #### Source
62
62
 
63
- src/dataunit/DataUnit.ts:1954
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:1956
63
+ src/dataunit/DataUnit.ts:1922
78
64
 
79
65
  ***
80
66
 
@@ -84,7 +70,7 @@ src/dataunit/DataUnit.ts:1956
84
70
 
85
71
  #### Source
86
72
 
87
- src/dataunit/DataUnit.ts:1953
73
+ src/dataunit/DataUnit.ts:1920
88
74
 
89
75
  ***
90
76
 
@@ -94,7 +80,7 @@ src/dataunit/DataUnit.ts:1953
94
80
 
95
81
  #### Source
96
82
 
97
- src/dataunit/DataUnit.ts:1955
83
+ src/dataunit/DataUnit.ts:1923
98
84
 
99
85
  ## Accessors
100
86
 
@@ -108,7 +94,7 @@ src/dataunit/DataUnit.ts:1955
108
94
 
109
95
  #### Source
110
96
 
111
- src/dataunit/DataUnit.ts:1988
97
+ src/dataunit/DataUnit.ts:1950
112
98
 
113
99
  ***
114
100
 
@@ -122,7 +108,7 @@ src/dataunit/DataUnit.ts:1988
122
108
 
123
109
  #### Source
124
110
 
125
- src/dataunit/DataUnit.ts:1978
111
+ src/dataunit/DataUnit.ts:1940
126
112
 
127
113
  ***
128
114
 
@@ -136,7 +122,7 @@ src/dataunit/DataUnit.ts:1978
136
122
 
137
123
  #### Source
138
124
 
139
- src/dataunit/DataUnit.ts:1968
125
+ src/dataunit/DataUnit.ts:1933
140
126
 
141
127
  ## Methods
142
128
 
@@ -150,7 +136,7 @@ src/dataunit/DataUnit.ts:1968
150
136
 
151
137
  #### Source
152
138
 
153
- src/dataunit/DataUnit.ts:1995
139
+ src/dataunit/DataUnit.ts:1957
154
140
 
155
141
  ***
156
142
 
@@ -164,4 +150,4 @@ src/dataunit/DataUnit.ts:1995
164
150
 
165
151
  #### Source
166
152
 
167
- src/dataunit/DataUnit.ts:1999
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:1839
17
+ src/dataunit/DataUnit.ts:1805
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1839
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1841
27
+ src/dataunit/DataUnit.ts:1807
28
28
 
29
29
  ***
30
30
 
@@ -34,7 +34,7 @@ src/dataunit/DataUnit.ts:1841
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1838
37
+ src/dataunit/DataUnit.ts:1804
38
38
 
39
39
  ***
40
40
 
@@ -44,4 +44,4 @@ src/dataunit/DataUnit.ts:1838
44
44
 
45
45
  #### Source
46
46
 
47
- src/dataunit/DataUnit.ts:1840
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:1947
17
+ src/dataunit/DataUnit.ts:1913
18
18
 
19
19
  ***
20
20
 
@@ -24,4 +24,4 @@ src/dataunit/DataUnit.ts:1947
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1948
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:1822
25
+ src/dataunit/DataUnit.ts:1788
package/interfaces/IRepository.md CHANGED
@@ -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`\>
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:1927
17
+ src/dataunit/DataUnit.ts:1893
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1927
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1928
27
+ src/dataunit/DataUnit.ts:1894
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1928
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1929
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:1934
17
+ src/dataunit/DataUnit.ts:1900
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1934
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1935
27
+ src/dataunit/DataUnit.ts:1901
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1935
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1933
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:1829
25
+ src/dataunit/DataUnit.ts:1795
26
26
 
27
27
  ***
28
28
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1829
32
32
 
33
33
  #### Source
34
34
 
35
- src/dataunit/DataUnit.ts:1828
35
+ src/dataunit/DataUnit.ts:1794
36
36
 
37
37
  ***
38
38
 
@@ -42,7 +42,7 @@ src/dataunit/DataUnit.ts:1828
42
42
 
43
43
  #### Source
44
44
 
45
- src/dataunit/DataUnit.ts:1826
45
+ src/dataunit/DataUnit.ts:1792
46
46
 
47
47
  ***
48
48
 
@@ -52,4 +52,4 @@ src/dataunit/DataUnit.ts:1826
52
52
 
53
53
  #### Source
54
54
 
55
- src/dataunit/DataUnit.ts:1827
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:1834
21
+ src/dataunit/DataUnit.ts:1800
22
22
 
23
23
  ***
24
24
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1834
32
32
 
33
33
  #### Source
34
34
 
35
- src/dataunit/DataUnit.ts:1829
35
+ src/dataunit/DataUnit.ts:1795
36
36
 
37
37
  ***
38
38
 
@@ -46,7 +46,7 @@ src/dataunit/DataUnit.ts:1829
46
46
 
47
47
  #### Source
48
48
 
49
- src/dataunit/DataUnit.ts:1828
49
+ src/dataunit/DataUnit.ts:1794
50
50
 
51
51
  ***
52
52
 
@@ -60,7 +60,7 @@ src/dataunit/DataUnit.ts:1828
60
60
 
61
61
  #### Source
62
62
 
63
- src/dataunit/DataUnit.ts:1826
63
+ src/dataunit/DataUnit.ts:1792
64
64
 
65
65
  ***
66
66
 
@@ -74,4 +74,4 @@ src/dataunit/DataUnit.ts:1826
74
74
 
75
75
  #### Source
76
76
 
77
- src/dataunit/DataUnit.ts:1827
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:1922
17
+ src/dataunit/DataUnit.ts:1888
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:1889
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: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-55365.0",
3
+ "version": "0.0.0-feat-dev-KB-34470.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:2004
17
+ src/dataunit/DataUnit.ts:1966