@rxap/remote-method 19.0.1-dev.2 → 19.0.1-dev.5

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 (66) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/README.md +24 -26
  3. package/compodoc/changelog.html +6 -0
  4. package/compodoc/dependencies.html +4 -4
  5. package/compodoc/index.html +26 -20
  6. package/compodoc/js/search/search_index.js +2 -2
  7. package/compodoc/properties.html +3 -2
  8. package/docs/documentation.json +911 -868
  9. package/docs/html/assets/hierarchy.js +1 -0
  10. package/docs/{assets → html/assets}/highlight.css +13 -6
  11. package/docs/html/assets/icons.js +18 -0
  12. package/docs/html/assets/icons.svg +1 -0
  13. package/docs/{assets → html/assets}/main.js +5 -4
  14. package/docs/html/assets/navigation.js +1 -0
  15. package/docs/html/assets/search.js +1 -0
  16. package/docs/html/assets/style.css +1611 -0
  17. package/docs/html/classes/BaseRemoteMethod.html +37 -0
  18. package/docs/html/classes/ProxyRemoteMethod.html +38 -0
  19. package/docs/html/classes/RemoteMethodLoader.html +4 -0
  20. package/docs/html/classes/RxapRemoteMethodError.html +26 -0
  21. package/docs/html/functions/RxapRemoteMethod.html +1 -0
  22. package/docs/html/hierarchy.html +1 -0
  23. package/docs/html/index.html +33 -0
  24. package/docs/html/interfaces/BaseRemoteMethodMetadata.html +3 -0
  25. package/docs/html/modules.html +1 -0
  26. package/docs/html/variables/REMOTE_METHOD_META_DATA.html +1 -0
  27. package/docs/html/variables/RXAP_PROXY_REMOTE_METHOD_TARGET.html +1 -0
  28. package/docs/markdown/README.md +37 -0
  29. package/docs/markdown/classes/BaseRemoteMethod.md +442 -0
  30. package/docs/markdown/classes/ProxyRemoteMethod.md +496 -0
  31. package/docs/markdown/classes/RemoteMethodLoader.md +123 -0
  32. package/docs/markdown/classes/RxapRemoteMethodError.md +265 -0
  33. package/docs/markdown/functions/RxapRemoteMethod.md +43 -0
  34. package/docs/markdown/globals.md +25 -0
  35. package/docs/markdown/interfaces/BaseRemoteMethodMetadata.md +37 -0
  36. package/docs/markdown/variables/REMOTE_METHOD_META_DATA.md +11 -0
  37. package/docs/markdown/variables/RXAP_PROXY_REMOTE_METHOD_TARGET.md +11 -0
  38. package/docs/wiki/Class.BaseRemoteMethod.md +438 -0
  39. package/docs/wiki/Class.ProxyRemoteMethod.md +492 -0
  40. package/docs/wiki/Class.RemoteMethodLoader.md +119 -0
  41. package/docs/wiki/Class.RxapRemoteMethodError.md +261 -0
  42. package/docs/wiki/Function.RxapRemoteMethod.md +39 -0
  43. package/docs/wiki/Home.md +33 -0
  44. package/docs/wiki/Interface.BaseRemoteMethodMetadata.md +33 -0
  45. package/docs/wiki/Variable.REMOTE_METHOD_META_DATA.md +7 -0
  46. package/docs/wiki/Variable.RXAP_PROXY_REMOTE_METHOD_TARGET.md +7 -0
  47. package/docs/wiki/_Sidebar.md +21 -0
  48. package/docs/wiki/globals.md +21 -0
  49. package/package.json +16 -15
  50. package/docs/assets/icons.js +0 -15
  51. package/docs/assets/icons.svg +0 -1
  52. package/docs/assets/navigation.js +0 -1
  53. package/docs/assets/search.js +0 -1
  54. package/docs/assets/style.css +0 -1412
  55. package/docs/classes/BaseRemoteMethod.html +0 -36
  56. package/docs/classes/ProxyRemoteMethod.html +0 -37
  57. package/docs/classes/RemoteMethodLoader.html +0 -4
  58. package/docs/classes/RxapRemoteMethodError.html +0 -26
  59. package/docs/functions/RxapRemoteMethod.html +0 -1
  60. package/docs/hierarchy.html +0 -1
  61. package/docs/index.html +0 -28
  62. package/docs/interfaces/BaseRemoteMethodMetadata.html +0 -3
  63. package/docs/modules.html +0 -9
  64. package/docs/variables/REMOTE_METHOD_META_DATA.html +0 -1
  65. package/docs/variables/RXAP_PROXY_REMOTE_METHOD_TARGET.html +0 -1
  66. /package/docs/{.nojekyll → html/.nojekyll} +0 -0
@@ -0,0 +1,265 @@
1
+ [**@rxap/remote-method**](../README.md)
2
+
3
+ ***
4
+
5
+ [@rxap/remote-method](../globals.md) / RxapRemoteMethodError
6
+
7
+ # Class: RxapRemoteMethodError
8
+
9
+ Defined in: [packages/angular/remote-method/src/lib/error.ts:3](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/remote-method/src/lib/error.ts#L3)
10
+
11
+ ## Extends
12
+
13
+ - `RxapError`
14
+
15
+ ## Constructors
16
+
17
+ ### new RxapRemoteMethodError()
18
+
19
+ > **new RxapRemoteMethodError**(`message`, `code`, `className`?): [`RxapRemoteMethodError`](RxapRemoteMethodError.md)
20
+
21
+ Defined in: [packages/angular/remote-method/src/lib/error.ts:5](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/remote-method/src/lib/error.ts#L5)
22
+
23
+ #### Parameters
24
+
25
+ ##### message
26
+
27
+ `string`
28
+
29
+ ##### code
30
+
31
+ `string`
32
+
33
+ ##### className?
34
+
35
+ `string`
36
+
37
+ #### Returns
38
+
39
+ [`RxapRemoteMethodError`](RxapRemoteMethodError.md)
40
+
41
+ #### Overrides
42
+
43
+ `RxapError.constructor`
44
+
45
+ ## Properties
46
+
47
+ ### \_packageName
48
+
49
+ > `protected` **\_packageName**: `string`
50
+
51
+ Defined in: [packages/utilities/src/lib/error.ts:6](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/utilities/src/lib/error.ts#L6)
52
+
53
+ #### Inherited from
54
+
55
+ `RxapError._packageName`
56
+
57
+ ***
58
+
59
+ ### code?
60
+
61
+ > `readonly` `optional` **code**: `string`
62
+
63
+ Defined in: [packages/utilities/src/lib/error.ts:8](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/utilities/src/lib/error.ts#L8)
64
+
65
+ #### Inherited from
66
+
67
+ `RxapError.code`
68
+
69
+ ***
70
+
71
+ ### message
72
+
73
+ > **message**: `string`
74
+
75
+ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1077
76
+
77
+ #### Inherited from
78
+
79
+ `RxapError.message`
80
+
81
+ ***
82
+
83
+ ### name
84
+
85
+ > **name**: `string`
86
+
87
+ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076
88
+
89
+ #### Inherited from
90
+
91
+ `RxapError.name`
92
+
93
+ ***
94
+
95
+ ### scope?
96
+
97
+ > `readonly` `optional` **scope**: `string`
98
+
99
+ Defined in: [packages/utilities/src/lib/error.ts:9](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/utilities/src/lib/error.ts#L9)
100
+
101
+ #### Inherited from
102
+
103
+ `RxapError.scope`
104
+
105
+ ***
106
+
107
+ ### stack?
108
+
109
+ > `readonly` `optional` **stack**: `string`
110
+
111
+ Defined in: [packages/utilities/src/lib/error.ts:10](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/utilities/src/lib/error.ts#L10)
112
+
113
+ #### Inherited from
114
+
115
+ `RxapError.stack`
116
+
117
+ ## Accessors
118
+
119
+ ### className
120
+
121
+ #### Get Signature
122
+
123
+ > **get** **className**(): `undefined` \| `string`
124
+
125
+ Defined in: [packages/utilities/src/lib/error.ts:23](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/utilities/src/lib/error.ts#L23)
126
+
127
+ ##### Returns
128
+
129
+ `undefined` \| `string`
130
+
131
+ #### Inherited from
132
+
133
+ `RxapError.className`
134
+
135
+ ***
136
+
137
+ ### packageName
138
+
139
+ #### Get Signature
140
+
141
+ > **get** **packageName**(): `string`
142
+
143
+ Defined in: [packages/utilities/src/lib/error.ts:19](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/utilities/src/lib/error.ts#L19)
144
+
145
+ ##### Returns
146
+
147
+ `string`
148
+
149
+ #### Inherited from
150
+
151
+ `RxapError.packageName`
152
+
153
+ ## Methods
154
+
155
+ ### ~~addSubPackageName()~~
156
+
157
+ > `protected` **addSubPackageName**(`subPackageName`): `void`
158
+
159
+ Defined in: [packages/utilities/src/lib/error.ts:64](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/utilities/src/lib/error.ts#L64)
160
+
161
+ **`Internal`**
162
+
163
+ Add's the sub package name to the current package name.
164
+
165
+ current package name -> with sub package name
166
+ @rxap/package -> @rxap/package/sub
167
+
168
+ #### Parameters
169
+
170
+ ##### subPackageName
171
+
172
+ `string`
173
+
174
+ The sub package name
175
+
176
+ #### Returns
177
+
178
+ `void`
179
+
180
+ #### Deprecated
181
+
182
+ removed
183
+
184
+ #### Inherited from
185
+
186
+ `RxapError.addSubPackageName`
187
+
188
+ ***
189
+
190
+ ### setPackageName()
191
+
192
+ > `protected` **setPackageName**(`packageName`): `void`
193
+
194
+ Defined in: [packages/utilities/src/lib/error.ts:74](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/utilities/src/lib/error.ts#L74)
195
+
196
+ **`Internal`**
197
+
198
+ Sets the package name
199
+
200
+ #### Parameters
201
+
202
+ ##### packageName
203
+
204
+ `string`
205
+
206
+ The new package name
207
+
208
+ #### Returns
209
+
210
+ `void`
211
+
212
+ #### Inherited from
213
+
214
+ `RxapError.setPackageName`
215
+
216
+ ***
217
+
218
+ ### ~~setSubPackageName()~~
219
+
220
+ > `protected` **setSubPackageName**(`subPackageName`): `void`
221
+
222
+ Defined in: [packages/utilities/src/lib/error.ts:49](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/utilities/src/lib/error.ts#L49)
223
+
224
+ **`Internal`**
225
+
226
+ Add's the sub package name to the current package name.
227
+
228
+ current package name -> with sub package name
229
+ @rxap/package -> @rxap/package/sub
230
+
231
+ #### Parameters
232
+
233
+ ##### subPackageName
234
+
235
+ `string`
236
+
237
+ The sub package name
238
+
239
+ #### Returns
240
+
241
+ `void`
242
+
243
+ #### Deprecated
244
+
245
+ use addSubPackageName instead
246
+
247
+ #### Inherited from
248
+
249
+ `RxapError.setSubPackageName`
250
+
251
+ ***
252
+
253
+ ### toJSON()
254
+
255
+ > **toJSON**(): `object`
256
+
257
+ Defined in: [packages/utilities/src/lib/error.ts:27](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/utilities/src/lib/error.ts#L27)
258
+
259
+ #### Returns
260
+
261
+ `object`
262
+
263
+ #### Inherited from
264
+
265
+ `RxapError.toJSON`
@@ -0,0 +1,43 @@
1
+ [**@rxap/remote-method**](../README.md)
2
+
3
+ ***
4
+
5
+ [@rxap/remote-method](../globals.md) / RxapRemoteMethod
6
+
7
+ # Function: RxapRemoteMethod()
8
+
9
+ > **RxapRemoteMethod**\<`MetaData`\>(`metadataOrId`, `className`, `packageName`): (`target`) => `void`
10
+
11
+ Defined in: [packages/angular/remote-method/src/lib/base.remote-method.ts:27](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/remote-method/src/lib/base.remote-method.ts#L27)
12
+
13
+ ## Type Parameters
14
+
15
+ • **MetaData** *extends* `BaseDefinitionMetadata` = `BaseDefinitionMetadata`
16
+
17
+ ## Parameters
18
+
19
+ ### metadataOrId
20
+
21
+ `string` | `MetaData`
22
+
23
+ ### className
24
+
25
+ `string` = `'BaseRemoteMethod'`
26
+
27
+ ### packageName
28
+
29
+ `string` = `'@rxap/remote-method'`
30
+
31
+ ## Returns
32
+
33
+ `Function`
34
+
35
+ ### Parameters
36
+
37
+ #### target
38
+
39
+ `any`
40
+
41
+ ### Returns
42
+
43
+ `void`
@@ -0,0 +1,25 @@
1
+ [**@rxap/remote-method**](README.md)
2
+
3
+ ***
4
+
5
+ # @rxap/remote-method
6
+
7
+ ## Classes
8
+
9
+ - [BaseRemoteMethod](classes/BaseRemoteMethod.md)
10
+ - [ProxyRemoteMethod](classes/ProxyRemoteMethod.md)
11
+ - [RemoteMethodLoader](classes/RemoteMethodLoader.md)
12
+ - [RxapRemoteMethodError](classes/RxapRemoteMethodError.md)
13
+
14
+ ## Interfaces
15
+
16
+ - [BaseRemoteMethodMetadata](interfaces/BaseRemoteMethodMetadata.md)
17
+
18
+ ## Variables
19
+
20
+ - [REMOTE\_METHOD\_META\_DATA](variables/REMOTE_METHOD_META_DATA.md)
21
+ - [RXAP\_PROXY\_REMOTE\_METHOD\_TARGET](variables/RXAP_PROXY_REMOTE_METHOD_TARGET.md)
22
+
23
+ ## Functions
24
+
25
+ - [RxapRemoteMethod](functions/RxapRemoteMethod.md)
@@ -0,0 +1,37 @@
1
+ [**@rxap/remote-method**](../README.md)
2
+
3
+ ***
4
+
5
+ [@rxap/remote-method](../globals.md) / BaseRemoteMethodMetadata
6
+
7
+ # Interface: BaseRemoteMethodMetadata
8
+
9
+ Defined in: [packages/angular/remote-method/src/lib/base.remote-method.ts:23](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/remote-method/src/lib/base.remote-method.ts#L23)
10
+
11
+ ## Extends
12
+
13
+ - `BaseDefinitionMetadata`
14
+
15
+ ## Indexable
16
+
17
+ \[`key`: `string`\]: `any`
18
+
19
+ ## Properties
20
+
21
+ ### id
22
+
23
+ > **id**: `string`
24
+
25
+ Defined in: [packages/angular/definition/src/lib/definition.metadata.ts:9](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/definition/src/lib/definition.metadata.ts#L9)
26
+
27
+ #### Inherited from
28
+
29
+ `BaseDefinitionMetadata.id`
30
+
31
+ ***
32
+
33
+ ### refresh?
34
+
35
+ > `optional` **refresh**: (`Type`\<`Refreshable`\> \| `InjectionToken`\<`Refreshable`\> \| `AbstractType`\<`Refreshable`\>)[]
36
+
37
+ Defined in: [packages/angular/remote-method/src/lib/base.remote-method.ts:24](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/remote-method/src/lib/base.remote-method.ts#L24)
@@ -0,0 +1,11 @@
1
+ [**@rxap/remote-method**](../README.md)
2
+
3
+ ***
4
+
5
+ [@rxap/remote-method](../globals.md) / REMOTE\_METHOD\_META\_DATA
6
+
7
+ # Variable: REMOTE\_METHOD\_META\_DATA
8
+
9
+ > `const` **REMOTE\_METHOD\_META\_DATA**: `InjectionToken`\<`unknown`\>
10
+
11
+ Defined in: [packages/angular/remote-method/src/lib/tokens.ts:3](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/remote-method/src/lib/tokens.ts#L3)
@@ -0,0 +1,11 @@
1
+ [**@rxap/remote-method**](../README.md)
2
+
3
+ ***
4
+
5
+ [@rxap/remote-method](../globals.md) / RXAP\_PROXY\_REMOTE\_METHOD\_TARGET
6
+
7
+ # Variable: RXAP\_PROXY\_REMOTE\_METHOD\_TARGET
8
+
9
+ > `const` **RXAP\_PROXY\_REMOTE\_METHOD\_TARGET**: `InjectionToken`\<`unknown`\>
10
+
11
+ Defined in: [packages/angular/remote-method/src/lib/tokens.ts:4](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/remote-method/src/lib/tokens.ts#L4)