@sankhyalabs/core-docs 0.0.0-hotfix-ga-KB-4098.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 (59) hide show
  1. package/README.md +63 -0
  2. package/classes/ApplicationContext.md +90 -0
  3. package/classes/ArrayUtils.md +99 -0
  4. package/classes/AuthorizedServiceCaller.md +76 -0
  5. package/classes/Change.md +190 -0
  6. package/classes/DataUnit.md +2427 -0
  7. package/classes/DataUnitAction.md +96 -0
  8. package/classes/DataUnitStorage.md +116 -0
  9. package/classes/DateUtils.md +327 -0
  10. package/classes/ElementIDUtils.md +308 -0
  11. package/classes/ErrorException.md +214 -0
  12. package/classes/ErrorTracking.md +62 -0
  13. package/classes/FloatingManager.md +530 -0
  14. package/classes/HttpProvider.md +96 -0
  15. package/classes/JSUtils.md +115 -0
  16. package/classes/MaskFormatter-1.md +347 -0
  17. package/classes/NumberUtils.md +335 -0
  18. package/classes/ObjectUtils.md +160 -0
  19. package/classes/OnboardingUtils.md +126 -0
  20. package/classes/PromiseSync.md +91 -0
  21. package/classes/ReadyUtil.md +115 -0
  22. package/classes/RequestMetadata.md +84 -0
  23. package/classes/SelectionInfo.md +168 -0
  24. package/classes/SkwHttpProvider.md +109 -0
  25. package/classes/StringUtils.md +562 -0
  26. package/classes/TimeFormatter.md +98 -0
  27. package/classes/UserAgentUtils.md +58 -0
  28. package/classes/VersionUtils.md +42 -0
  29. package/classes/WaitingChangeException.md +200 -0
  30. package/classes/WarningException.md +214 -0
  31. package/enums/Action.md +283 -0
  32. package/enums/ChangeOperation.md +52 -0
  33. package/enums/DataType.md +63 -0
  34. package/enums/DependencyType.md +41 -0
  35. package/enums/SelectionMode.md +30 -0
  36. package/enums/SortMode.md +30 -0
  37. package/enums/UserInterface.md +195 -0
  38. package/interfaces/ChildDescriptor.md +41 -0
  39. package/interfaces/ChildLink.md +30 -0
  40. package/interfaces/DUActionInterceptor.md +29 -0
  41. package/interfaces/ExecutionContext.md +58 -0
  42. package/interfaces/FieldDescriptor.md +140 -0
  43. package/interfaces/Filter.md +41 -0
  44. package/interfaces/IElementIDInfo.md +30 -0
  45. package/interfaces/LoadDataRequest.md +101 -0
  46. package/interfaces/LoadDataResponse.md +36 -0
  47. package/interfaces/PageRequest.md +41 -0
  48. package/interfaces/PaginationInfo.md +75 -0
  49. package/interfaces/PromiseSyncCallback.md +39 -0
  50. package/interfaces/QuickFilter.md +41 -0
  51. package/interfaces/Record.md +62 -0
  52. package/interfaces/SavedRecord.md +85 -0
  53. package/interfaces/Sort.md +41 -0
  54. package/interfaces/SortingProvider.md +29 -0
  55. package/interfaces/UnitMetadata.md +52 -0
  56. package/interfaces/WaitingChange.md +41 -0
  57. package/modules/MaskFormatter.md +37 -0
  58. package/modules.md +73 -0
  59. package/package.json +14 -0
package/classes/SelectionInfo.md ADDED
@@ -0,0 +1,168 @@
1
+ [@sankhyalabs/core](../README.md) / [Exports](../modules.md) / SelectionInfo
2
+
3
+ # Class: SelectionInfo
4
+
5
+ ## Table of contents
6
+
7
+ ### Constructors
8
+
9
+ - [constructor](SelectionInfo.md#constructor)
10
+
11
+ ### Properties
12
+
13
+ - [\_records](SelectionInfo.md#_records)
14
+ - [\_total](SelectionInfo.md#_total)
15
+ - [filters](SelectionInfo.md#filters)
16
+ - [mode](SelectionInfo.md#mode)
17
+ - [sort](SelectionInfo.md#sort)
18
+
19
+ ### Accessors
20
+
21
+ - [length](SelectionInfo.md#length)
22
+ - [recordIds](SelectionInfo.md#recordids)
23
+ - [records](SelectionInfo.md#records)
24
+
25
+ ### Methods
26
+
27
+ - [isAllRecords](SelectionInfo.md#isallrecords)
28
+ - [isEmpty](SelectionInfo.md#isempty)
29
+
30
+ ## Constructors
31
+
32
+ ### constructor
33
+
34
+ • **new SelectionInfo**(`records`, `mode?`, `total?`, `filters?`, `sort?`)
35
+
36
+ #### Parameters
37
+
38
+ | Name | Type | Default value |
39
+ | :------ | :------ | :------ |
40
+ | `records` | [`Record`](../interfaces/Record.md)[] | `undefined` |
41
+ | `mode` | [`SelectionMode`](../enums/SelectionMode.md) | `SelectionMode.SOME_RECORDS` |
42
+ | `total?` | `number` | `undefined` |
43
+ | `filters?` | [`Filter`](../interfaces/Filter.md)[] | `undefined` |
44
+ | `sort?` | [`Sort`](../interfaces/Sort.md)[] | `undefined` |
45
+
46
+ #### Defined in
47
+
48
+ src/dataunit/DataUnit.ts:1769
49
+
50
+ ## Properties
51
+
52
+ ### \_records
53
+
54
+ • `Private` **\_records**: [`Record`](../interfaces/Record.md)[]
55
+
56
+ #### Defined in
57
+
58
+ src/dataunit/DataUnit.ts:1763
59
+
60
+ ___
61
+
62
+ ### \_total
63
+
64
+ • `Private` `Optional` **\_total**: `number`
65
+
66
+ #### Defined in
67
+
68
+ src/dataunit/DataUnit.ts:1765
69
+
70
+ ___
71
+
72
+ ### filters
73
+
74
+ • `Optional` **filters**: [`Filter`](../interfaces/Filter.md)[]
75
+
76
+ #### Defined in
77
+
78
+ src/dataunit/DataUnit.ts:1766
79
+
80
+ ___
81
+
82
+ ### mode
83
+
84
+ • **mode**: [`SelectionMode`](../enums/SelectionMode.md)
85
+
86
+ #### Defined in
87
+
88
+ src/dataunit/DataUnit.ts:1764
89
+
90
+ ___
91
+
92
+ ### sort
93
+
94
+ • `Optional` **sort**: [`Sort`](../interfaces/Sort.md)[]
95
+
96
+ #### Defined in
97
+
98
+ src/dataunit/DataUnit.ts:1767
99
+
100
+ ## Accessors
101
+
102
+ ### length
103
+
104
+ • `get` **length**(): `number`
105
+
106
+ #### Returns
107
+
108
+ `number`
109
+
110
+ #### Defined in
111
+
112
+ src/dataunit/DataUnit.ts:1794
113
+
114
+ ___
115
+
116
+ ### recordIds
117
+
118
+ • `get` **recordIds**(): `undefined` \| `string`[]
119
+
120
+ #### Returns
121
+
122
+ `undefined` \| `string`[]
123
+
124
+ #### Defined in
125
+
126
+ src/dataunit/DataUnit.ts:1784
127
+
128
+ ___
129
+
130
+ ### records
131
+
132
+ • `get` **records**(): `undefined` \| [`Record`](../interfaces/Record.md)[]
133
+
134
+ #### Returns
135
+
136
+ `undefined` \| [`Record`](../interfaces/Record.md)[]
137
+
138
+ #### Defined in
139
+
140
+ src/dataunit/DataUnit.ts:1777
141
+
142
+ ## Methods
143
+
144
+ ### isAllRecords
145
+
146
+ ▸ **isAllRecords**(): `boolean`
147
+
148
+ #### Returns
149
+
150
+ `boolean`
151
+
152
+ #### Defined in
153
+
154
+ src/dataunit/DataUnit.ts:1801
155
+
156
+ ___
157
+
158
+ ### isEmpty
159
+
160
+ ▸ **isEmpty**(): `boolean`
161
+
162
+ #### Returns
163
+
164
+ `boolean`
165
+
166
+ #### Defined in
167
+
168
+ src/dataunit/DataUnit.ts:1805
package/classes/SkwHttpProvider.md ADDED
@@ -0,0 +1,109 @@
1
+ [@sankhyalabs/core](../README.md) / [Exports](../modules.md) / SkwHttpProvider
2
+
3
+ # Class: SkwHttpProvider
4
+
5
+ ## Table of contents
6
+
7
+ ### Constructors
8
+
9
+ - [constructor](SkwHttpProvider.md#constructor)
10
+
11
+ ### Properties
12
+
13
+ - [STATUS\_CANCELED](SkwHttpProvider.md#status_canceled)
14
+ - [STATUS\_ERROR](SkwHttpProvider.md#status_error)
15
+ - [STATUS\_INFO](SkwHttpProvider.md#status_info)
16
+ - [STATUS\_OK](SkwHttpProvider.md#status_ok)
17
+ - [STATUS\_TIMEOUT](SkwHttpProvider.md#status_timeout)
18
+ - [\_counter](SkwHttpProvider.md#_counter)
19
+
20
+ ### Methods
21
+
22
+ - [callService](SkwHttpProvider.md#callservice)
23
+
24
+ ## Constructors
25
+
26
+ ### constructor
27
+
28
+ • **new SkwHttpProvider**()
29
+
30
+ ## Properties
31
+
32
+ ### STATUS\_CANCELED
33
+
34
+ ▪ `Static` **STATUS\_CANCELED**: `number` = `4`
35
+
36
+ #### Defined in
37
+
38
+ src/http/SkwHttpProvider.ts:11
39
+
40
+ ___
41
+
42
+ ### STATUS\_ERROR
43
+
44
+ ▪ `Static` **STATUS\_ERROR**: `number` = `0`
45
+
46
+ #### Defined in
47
+
48
+ src/http/SkwHttpProvider.ts:7
49
+
50
+ ___
51
+
52
+ ### STATUS\_INFO
53
+
54
+ ▪ `Static` **STATUS\_INFO**: `number` = `2`
55
+
56
+ #### Defined in
57
+
58
+ src/http/SkwHttpProvider.ts:9
59
+
60
+ ___
61
+
62
+ ### STATUS\_OK
63
+
64
+ ▪ `Static` **STATUS\_OK**: `number` = `1`
65
+
66
+ #### Defined in
67
+
68
+ src/http/SkwHttpProvider.ts:8
69
+
70
+ ___
71
+
72
+ ### STATUS\_TIMEOUT
73
+
74
+ ▪ `Static` **STATUS\_TIMEOUT**: `number` = `3`
75
+
76
+ #### Defined in
77
+
78
+ src/http/SkwHttpProvider.ts:10
79
+
80
+ ___
81
+
82
+ ### \_counter
83
+
84
+ ▪ `Static` **\_counter**: `number` = `0`
85
+
86
+ #### Defined in
87
+
88
+ src/http/SkwHttpProvider.ts:5
89
+
90
+ ## Methods
91
+
92
+ ### callService
93
+
94
+ ▸ `Static` **callService**(`serviceName`, `content`): `Promise`<`Object`\>
95
+
96
+ #### Parameters
97
+
98
+ | Name | Type |
99
+ | :------ | :------ |
100
+ | `serviceName` | `string` |
101
+ | `content` | `Object` |
102
+
103
+ #### Returns
104
+
105
+ `Promise`<`Object`\>
106
+
107
+ #### Defined in
108
+
109
+ src/http/SkwHttpProvider.ts:13