@sankhyalabs/core-docs 5.20.0-rc.4 → 5.20.0-rc.40

Sign up to get free protection for your applications and to get access to all the features.
Files changed (32) hide show
  1. package/classes/Base64Utils.md +39 -0
  2. package/classes/Change.md +11 -11
  3. package/classes/DataUnit.md +385 -135
  4. package/classes/DateUtils.md +8 -8
  5. package/classes/IDBRepository.md +22 -0
  6. package/classes/LockManager.md +191 -0
  7. package/classes/MaskFormatter.md +66 -14
  8. package/classes/ObjectUtils.md +141 -0
  9. package/classes/SelectionInfo.md +25 -11
  10. package/classes/ServiceCanceledException.md +193 -0
  11. package/classes/ServiceUtils.md +67 -0
  12. package/classes/SilentException.md +193 -0
  13. package/classes/StringUtils.md +24 -0
  14. package/enumerations/Action.md +41 -21
  15. package/enumerations/ChangeOperation.md +4 -4
  16. package/enumerations/LockManagerOperation.md +21 -0
  17. package/enumerations/SelectionMode.md +2 -2
  18. package/enumerations/StorageType.md +37 -0
  19. package/globals.md +7 -0
  20. package/interfaces/DUActionInterceptor.md +1 -1
  21. package/interfaces/IRepository.md +18 -0
  22. package/interfaces/LoadDataRequest.md +1 -1
  23. package/interfaces/PageRequest.md +3 -3
  24. package/interfaces/PaginationInfo.md +13 -0
  25. package/interfaces/QuickFilter.md +3 -3
  26. package/interfaces/Record.md +4 -4
  27. package/interfaces/SavedRecord.md +5 -5
  28. package/interfaces/WaitingChange.md +3 -3
  29. package/namespaces/MaskFormatter/type-aliases/MaskCharacter.md +1 -1
  30. package/namespaces/MaskFormatter/variables/MaskCharacter.md +1 -1
  31. package/package.json +1 -1
  32. package/type-aliases/DataUnitEventOptions.md +1 -1
package/enumerations/LockManagerOperation.md ADDED
@@ -0,0 +1,21 @@
1
+ [**@sankhyalabs/core**](../README.md) • **Docs**
2
+
3
+ ***
4
+
5
+ [@sankhyalabs/core](../globals.md) / LockManagerOperation
6
+
7
+ # Enumeration: LockManagerOperation
8
+
9
+ Define os tipos de operação que o locker pode controlar
10
+
11
+ ## Enumeration Members
12
+
13
+ ### TASKBAR\_CLICK
14
+
15
+ > **TASKBAR\_CLICK**: `"taskbar_click"`
16
+
17
+ Operação de lock utilizada para controlar cliques nos botoes da taskbar.
18
+
19
+ #### Source
20
+
21
+ src/utils/LockManager.ts:9
package/enumerations/SelectionMode.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1905
17
+ src/dataunit/DataUnit.ts:2058
18
18
 
19
19
  ***
20
20
 
@@ -24,4 +24,4 @@ src/dataunit/DataUnit.ts:1905
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1906
27
+ src/dataunit/DataUnit.ts:2059
package/enumerations/StorageType.md ADDED
@@ -0,0 +1,37 @@
1
+ [**@sankhyalabs/core**](../README.md) • **Docs**
2
+
3
+ ***
4
+
5
+ [@sankhyalabs/core](../globals.md) / StorageType
6
+
7
+ # Enumeration: StorageType
8
+
9
+ ## Enumeration Members
10
+
11
+ ### IN\_MEMORY\_CACHE
12
+
13
+ > **IN\_MEMORY\_CACHE**: `"inMemoryCache"`
14
+
15
+ #### Source
16
+
17
+ src/utils/CacheManager/interfaces/index.ts:2
18
+
19
+ ***
20
+
21
+ ### LOCAL\_STORAGE
22
+
23
+ > **LOCAL\_STORAGE**: `"localStorage"`
24
+
25
+ #### Source
26
+
27
+ src/utils/CacheManager/interfaces/index.ts:4
28
+
29
+ ***
30
+
31
+ ### SESSION\_STORAGE
32
+
33
+ > **SESSION\_STORAGE**: `"sessionStorage"`
34
+
35
+ #### Source
36
+
37
+ src/utils/CacheManager/interfaces/index.ts:3
package/globals.md CHANGED
@@ -14,9 +14,11 @@
14
14
  - [ChangeOperation](enumerations/ChangeOperation.md)
15
15
  - [DataType](enumerations/DataType.md)
16
16
  - [DependencyType](enumerations/DependencyType.md)
17
+ - [LockManagerOperation](enumerations/LockManagerOperation.md)
17
18
  - [OverflowDirection](enumerations/OverflowDirection.md)
18
19
  - [SelectionMode](enumerations/SelectionMode.md)
19
20
  - [SortMode](enumerations/SortMode.md)
21
+ - [StorageType](enumerations/StorageType.md)
20
22
  - [UserInterface](enumerations/UserInterface.md)
21
23
 
22
24
  ## Classes
@@ -24,6 +26,7 @@
24
26
  - [ApplicationContext](classes/ApplicationContext.md)
25
27
  - [ArrayUtils](classes/ArrayUtils.md)
26
28
  - [AuthorizedServiceCaller](classes/AuthorizedServiceCaller.md)
29
+ - [Base64Utils](classes/Base64Utils.md)
27
30
  - [Change](classes/Change.md)
28
31
  - [DataUnit](classes/DataUnit.md)
29
32
  - [DataUnitAction](classes/DataUnitAction.md)
@@ -39,6 +42,7 @@
39
42
  - [IDBRepository](classes/IDBRepository.md)
40
43
  - [JSUtils](classes/JSUtils.md)
41
44
  - [KeyboardManager](classes/KeyboardManager.md)
45
+ - [LockManager](classes/LockManager.md)
42
46
  - [MaskFormatter](classes/MaskFormatter.md)
43
47
  - [NumberUtils](classes/NumberUtils.md)
44
48
  - [ObjectUtils](classes/ObjectUtils.md)
@@ -49,6 +53,9 @@
49
53
  - [RequestMetadata](classes/RequestMetadata.md)
50
54
  - [SearchUtils](classes/SearchUtils.md)
51
55
  - [SelectionInfo](classes/SelectionInfo.md)
56
+ - [ServiceCanceledException](classes/ServiceCanceledException.md)
57
+ - [ServiceUtils](classes/ServiceUtils.md)
58
+ - [SilentException](classes/SilentException.md)
52
59
  - [SkwHttpProvider](classes/SkwHttpProvider.md)
53
60
  - [StringUtils](classes/StringUtils.md)
54
61
  - [TimeFormatter](classes/TimeFormatter.md)
package/interfaces/DUActionInterceptor.md CHANGED
@@ -22,4 +22,4 @@
22
22
 
23
23
  #### Source
24
24
 
25
- src/dataunit/DataUnit.ts:1780
25
+ src/dataunit/DataUnit.ts:1933
package/interfaces/IRepository.md CHANGED
@@ -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`\>
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:1885
17
+ src/dataunit/DataUnit.ts:2038
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1885
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1886
27
+ src/dataunit/DataUnit.ts:2039
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1886
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1887
37
+ src/dataunit/DataUnit.ts:2040
package/interfaces/PaginationInfo.md CHANGED
@@ -70,6 +70,19 @@ src/dataunit/loading/PaginationInfo.ts:11
70
70
 
71
71
  ***
72
72
 
73
+ ### loadingInProgress?
74
+
75
+ > `optional` **loadingInProgress**: `boolean`
76
+
77
+ Informa se o carregamento de dados em background está sendo executado
78
+ Caso o dataunit não tenha carga paralela o valor será indefinido
79
+
80
+ #### Source
81
+
82
+ src/dataunit/loading/PaginationInfo.ts:25
83
+
84
+ ***
85
+
73
86
  ### total?
74
87
 
75
88
  > `optional` **total**: `number`
package/interfaces/QuickFilter.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1892
17
+ src/dataunit/DataUnit.ts:2045
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1892
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1893
27
+ src/dataunit/DataUnit.ts:2046
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1893
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1891
37
+ src/dataunit/DataUnit.ts:2044
package/interfaces/Record.md CHANGED
@@ -22,7 +22,7 @@
22
22
 
23
23
  #### Source
24
24
 
25
- src/dataunit/DataUnit.ts:1787
25
+ src/dataunit/DataUnit.ts:1940
26
26
 
27
27
  ***
28
28
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1787
32
32
 
33
33
  #### Source
34
34
 
35
- src/dataunit/DataUnit.ts:1786
35
+ src/dataunit/DataUnit.ts:1939
36
36
 
37
37
  ***
38
38
 
@@ -42,7 +42,7 @@ src/dataunit/DataUnit.ts:1786
42
42
 
43
43
  #### Source
44
44
 
45
- src/dataunit/DataUnit.ts:1784
45
+ src/dataunit/DataUnit.ts:1937
46
46
 
47
47
  ***
48
48
 
@@ -52,4 +52,4 @@ src/dataunit/DataUnit.ts:1784
52
52
 
53
53
  #### Source
54
54
 
55
- src/dataunit/DataUnit.ts:1785
55
+ src/dataunit/DataUnit.ts:1938
package/interfaces/SavedRecord.md CHANGED
@@ -18,7 +18,7 @@
18
18
 
19
19
  #### Source
20
20
 
21
- src/dataunit/DataUnit.ts:1792
21
+ src/dataunit/DataUnit.ts:1945
22
22
 
23
23
  ***
24
24
 
@@ -32,7 +32,7 @@ src/dataunit/DataUnit.ts:1792
32
32
 
33
33
  #### Source
34
34
 
35
- src/dataunit/DataUnit.ts:1787
35
+ src/dataunit/DataUnit.ts:1940
36
36
 
37
37
  ***
38
38
 
@@ -46,7 +46,7 @@ src/dataunit/DataUnit.ts:1787
46
46
 
47
47
  #### Source
48
48
 
49
- src/dataunit/DataUnit.ts:1786
49
+ src/dataunit/DataUnit.ts:1939
50
50
 
51
51
  ***
52
52
 
@@ -60,7 +60,7 @@ src/dataunit/DataUnit.ts:1786
60
60
 
61
61
  #### Source
62
62
 
63
- src/dataunit/DataUnit.ts:1784
63
+ src/dataunit/DataUnit.ts:1937
64
64
 
65
65
  ***
66
66
 
@@ -74,4 +74,4 @@ src/dataunit/DataUnit.ts:1784
74
74
 
75
75
  #### Source
76
76
 
77
- src/dataunit/DataUnit.ts:1785
77
+ src/dataunit/DataUnit.ts:1938
package/interfaces/WaitingChange.md CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Source
16
16
 
17
- src/dataunit/DataUnit.ts:1880
17
+ src/dataunit/DataUnit.ts:2033
18
18
 
19
19
  ***
20
20
 
@@ -24,7 +24,7 @@ src/dataunit/DataUnit.ts:1880
24
24
 
25
25
  #### Source
26
26
 
27
- src/dataunit/DataUnit.ts:1881
27
+ src/dataunit/DataUnit.ts:2034
28
28
 
29
29
  ***
30
30
 
@@ -34,4 +34,4 @@ src/dataunit/DataUnit.ts:1881
34
34
 
35
35
  #### Source
36
36
 
37
- src/dataunit/DataUnit.ts:1879
37
+ src/dataunit/DataUnit.ts:2032
package/namespaces/MaskFormatter/type-aliases/MaskCharacter.md CHANGED
@@ -10,4 +10,4 @@
10
10
 
11
11
  ## Source
12
12
 
13
- src/utils/MaskFormatter.ts:166
13
+ src/utils/MaskFormatter.ts:257
package/namespaces/MaskFormatter/variables/MaskCharacter.md CHANGED
@@ -10,4 +10,4 @@
10
10
 
11
11
  ## Source
12
12
 
13
- src/utils/MaskFormatter.ts:166
13
+ src/utils/MaskFormatter.ts:257
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/core-docs",
3
- "version": "5.20.0-rc.4",
3
+ "version": "5.20.0-rc.40",
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:1958
17
+ src/dataunit/DataUnit.ts:2115