@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.
- package/CHANGELOG.md +12 -0
- package/README.md +24 -26
- package/compodoc/changelog.html +6 -0
- package/compodoc/dependencies.html +4 -4
- package/compodoc/index.html +26 -20
- package/compodoc/js/search/search_index.js +2 -2
- package/compodoc/properties.html +3 -2
- package/docs/documentation.json +911 -868
- package/docs/html/assets/hierarchy.js +1 -0
- package/docs/{assets → html/assets}/highlight.css +13 -6
- package/docs/html/assets/icons.js +18 -0
- package/docs/html/assets/icons.svg +1 -0
- package/docs/{assets → html/assets}/main.js +5 -4
- package/docs/html/assets/navigation.js +1 -0
- package/docs/html/assets/search.js +1 -0
- package/docs/html/assets/style.css +1611 -0
- package/docs/html/classes/BaseRemoteMethod.html +37 -0
- package/docs/html/classes/ProxyRemoteMethod.html +38 -0
- package/docs/html/classes/RemoteMethodLoader.html +4 -0
- package/docs/html/classes/RxapRemoteMethodError.html +26 -0
- package/docs/html/functions/RxapRemoteMethod.html +1 -0
- package/docs/html/hierarchy.html +1 -0
- package/docs/html/index.html +33 -0
- package/docs/html/interfaces/BaseRemoteMethodMetadata.html +3 -0
- package/docs/html/modules.html +1 -0
- package/docs/html/variables/REMOTE_METHOD_META_DATA.html +1 -0
- package/docs/html/variables/RXAP_PROXY_REMOTE_METHOD_TARGET.html +1 -0
- package/docs/markdown/README.md +37 -0
- package/docs/markdown/classes/BaseRemoteMethod.md +442 -0
- package/docs/markdown/classes/ProxyRemoteMethod.md +496 -0
- package/docs/markdown/classes/RemoteMethodLoader.md +123 -0
- package/docs/markdown/classes/RxapRemoteMethodError.md +265 -0
- package/docs/markdown/functions/RxapRemoteMethod.md +43 -0
- package/docs/markdown/globals.md +25 -0
- package/docs/markdown/interfaces/BaseRemoteMethodMetadata.md +37 -0
- package/docs/markdown/variables/REMOTE_METHOD_META_DATA.md +11 -0
- package/docs/markdown/variables/RXAP_PROXY_REMOTE_METHOD_TARGET.md +11 -0
- package/docs/wiki/Class.BaseRemoteMethod.md +438 -0
- package/docs/wiki/Class.ProxyRemoteMethod.md +492 -0
- package/docs/wiki/Class.RemoteMethodLoader.md +119 -0
- package/docs/wiki/Class.RxapRemoteMethodError.md +261 -0
- package/docs/wiki/Function.RxapRemoteMethod.md +39 -0
- package/docs/wiki/Home.md +33 -0
- package/docs/wiki/Interface.BaseRemoteMethodMetadata.md +33 -0
- package/docs/wiki/Variable.REMOTE_METHOD_META_DATA.md +7 -0
- package/docs/wiki/Variable.RXAP_PROXY_REMOTE_METHOD_TARGET.md +7 -0
- package/docs/wiki/_Sidebar.md +21 -0
- package/docs/wiki/globals.md +21 -0
- package/package.json +16 -15
- package/docs/assets/icons.js +0 -15
- package/docs/assets/icons.svg +0 -1
- package/docs/assets/navigation.js +0 -1
- package/docs/assets/search.js +0 -1
- package/docs/assets/style.css +0 -1412
- package/docs/classes/BaseRemoteMethod.html +0 -36
- package/docs/classes/ProxyRemoteMethod.html +0 -37
- package/docs/classes/RemoteMethodLoader.html +0 -4
- package/docs/classes/RxapRemoteMethodError.html +0 -26
- package/docs/functions/RxapRemoteMethod.html +0 -1
- package/docs/hierarchy.html +0 -1
- package/docs/index.html +0 -28
- package/docs/interfaces/BaseRemoteMethodMetadata.html +0 -3
- package/docs/modules.html +0 -9
- package/docs/variables/REMOTE_METHOD_META_DATA.html +0 -1
- package/docs/variables/RXAP_PROXY_REMOTE_METHOD_TARGET.html +0 -1
- /package/docs/{.nojekyll → html/.nojekyll} +0 -0
|
@@ -0,0 +1,496 @@
|
|
|
1
|
+
[**@rxap/remote-method**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@rxap/remote-method](../globals.md) / ProxyRemoteMethod
|
|
6
|
+
|
|
7
|
+
# Class: `abstract` ProxyRemoteMethod\<ReturnType, SourceParameter, TargetParameter\>
|
|
8
|
+
|
|
9
|
+
Defined in: [packages/angular/remote-method/src/lib/proxy.remote-method.ts:17](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/remote-method/src/lib/proxy.remote-method.ts#L17)
|
|
10
|
+
|
|
11
|
+
## Extends
|
|
12
|
+
|
|
13
|
+
- [`BaseRemoteMethod`](BaseRemoteMethod.md)\<`ReturnType`, `SourceParameter`\>
|
|
14
|
+
|
|
15
|
+
## Type Parameters
|
|
16
|
+
|
|
17
|
+
• **ReturnType** = `any`
|
|
18
|
+
|
|
19
|
+
• **SourceParameter** = `any`
|
|
20
|
+
|
|
21
|
+
• **TargetParameter** = `SourceParameter`
|
|
22
|
+
|
|
23
|
+
## Constructors
|
|
24
|
+
|
|
25
|
+
### new ProxyRemoteMethod()
|
|
26
|
+
|
|
27
|
+
> **new ProxyRemoteMethod**\<`ReturnType`, `SourceParameter`, `TargetParameter`\>(`remoteMethod`, `injector`, `metadata`): [`ProxyRemoteMethod`](ProxyRemoteMethod.md)\<`ReturnType`, `SourceParameter`, `TargetParameter`\>
|
|
28
|
+
|
|
29
|
+
Defined in: [packages/angular/remote-method/src/lib/proxy.remote-method.ts:20](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/remote-method/src/lib/proxy.remote-method.ts#L20)
|
|
30
|
+
|
|
31
|
+
#### Parameters
|
|
32
|
+
|
|
33
|
+
##### remoteMethod
|
|
34
|
+
|
|
35
|
+
[`BaseRemoteMethod`](BaseRemoteMethod.md)
|
|
36
|
+
|
|
37
|
+
##### injector
|
|
38
|
+
|
|
39
|
+
`null` | `Injector`
|
|
40
|
+
|
|
41
|
+
##### metadata
|
|
42
|
+
|
|
43
|
+
[`BaseRemoteMethodMetadata`](../interfaces/BaseRemoteMethodMetadata.md) = `remoteMethod.metadata`
|
|
44
|
+
|
|
45
|
+
#### Returns
|
|
46
|
+
|
|
47
|
+
[`ProxyRemoteMethod`](ProxyRemoteMethod.md)\<`ReturnType`, `SourceParameter`, `TargetParameter`\>
|
|
48
|
+
|
|
49
|
+
#### Overrides
|
|
50
|
+
|
|
51
|
+
[`BaseRemoteMethod`](BaseRemoteMethod.md).[`constructor`](BaseRemoteMethod.md#constructors)
|
|
52
|
+
|
|
53
|
+
## Properties
|
|
54
|
+
|
|
55
|
+
### \_\_id
|
|
56
|
+
|
|
57
|
+
> **\_\_id**: `string`
|
|
58
|
+
|
|
59
|
+
Defined in: [packages/angular/definition/src/lib/definition.ts:61](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/definition/src/lib/definition.ts#L61)
|
|
60
|
+
|
|
61
|
+
**`Internal`**
|
|
62
|
+
|
|
63
|
+
unique internal id
|
|
64
|
+
|
|
65
|
+
#### Inherited from
|
|
66
|
+
|
|
67
|
+
[`BaseRemoteMethod`](BaseRemoteMethod.md).[`__id`](BaseRemoteMethod.md#__id)
|
|
68
|
+
|
|
69
|
+
***
|
|
70
|
+
|
|
71
|
+
### \_initialised
|
|
72
|
+
|
|
73
|
+
> `protected` **\_initialised**: `boolean` = `false`
|
|
74
|
+
|
|
75
|
+
Defined in: [packages/angular/definition/src/lib/definition.ts:62](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/definition/src/lib/definition.ts#L62)
|
|
76
|
+
|
|
77
|
+
#### Inherited from
|
|
78
|
+
|
|
79
|
+
[`BaseRemoteMethod`](BaseRemoteMethod.md).[`_initialised`](BaseRemoteMethod.md#_initialised)
|
|
80
|
+
|
|
81
|
+
***
|
|
82
|
+
|
|
83
|
+
### destroyed$
|
|
84
|
+
|
|
85
|
+
> `readonly` **destroyed$**: `undefined` \| `Subject`\<`void`\>
|
|
86
|
+
|
|
87
|
+
Defined in: [packages/angular/definition/src/lib/definition.ts:48](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/definition/src/lib/definition.ts#L48)
|
|
88
|
+
|
|
89
|
+
Emits if the data source is destroyed
|
|
90
|
+
|
|
91
|
+
#### Inherited from
|
|
92
|
+
|
|
93
|
+
[`BaseRemoteMethod`](BaseRemoteMethod.md).[`destroyed$`](BaseRemoteMethod.md#destroyed$)
|
|
94
|
+
|
|
95
|
+
***
|
|
96
|
+
|
|
97
|
+
### executed$
|
|
98
|
+
|
|
99
|
+
> **executed$**: `Subject`\<`ReturnType`\>
|
|
100
|
+
|
|
101
|
+
Defined in: [packages/angular/remote-method/src/lib/base.remote-method.ts:42](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/remote-method/src/lib/base.remote-method.ts#L42)
|
|
102
|
+
|
|
103
|
+
#### Inherited from
|
|
104
|
+
|
|
105
|
+
[`BaseRemoteMethod`](BaseRemoteMethod.md).[`executed$`](BaseRemoteMethod.md#executed$)
|
|
106
|
+
|
|
107
|
+
***
|
|
108
|
+
|
|
109
|
+
### executionsInProgress$
|
|
110
|
+
|
|
111
|
+
> **executionsInProgress$**: `CounterSubject`
|
|
112
|
+
|
|
113
|
+
Defined in: [packages/angular/remote-method/src/lib/base.remote-method.ts:44](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/remote-method/src/lib/base.remote-method.ts#L44)
|
|
114
|
+
|
|
115
|
+
#### Inherited from
|
|
116
|
+
|
|
117
|
+
[`BaseRemoteMethod`](BaseRemoteMethod.md).[`executionsInProgress$`](BaseRemoteMethod.md#executionsinprogress$)
|
|
118
|
+
|
|
119
|
+
***
|
|
120
|
+
|
|
121
|
+
### initialised$
|
|
122
|
+
|
|
123
|
+
> `readonly` **initialised$**: `undefined` \| `Subject`\<`void`\>
|
|
124
|
+
|
|
125
|
+
Defined in: [packages/angular/definition/src/lib/definition.ts:52](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/definition/src/lib/definition.ts#L52)
|
|
126
|
+
|
|
127
|
+
Emits if the data source is initialised
|
|
128
|
+
|
|
129
|
+
#### Inherited from
|
|
130
|
+
|
|
131
|
+
[`BaseRemoteMethod`](BaseRemoteMethod.md).[`initialised$`](BaseRemoteMethod.md#initialised$)
|
|
132
|
+
|
|
133
|
+
***
|
|
134
|
+
|
|
135
|
+
### injector
|
|
136
|
+
|
|
137
|
+
> `readonly` **injector**: `Injector`
|
|
138
|
+
|
|
139
|
+
Defined in: [packages/angular/remote-method/src/lib/base.remote-method.ts:46](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/remote-method/src/lib/base.remote-method.ts#L46)
|
|
140
|
+
|
|
141
|
+
#### Inherited from
|
|
142
|
+
|
|
143
|
+
[`BaseRemoteMethod`](BaseRemoteMethod.md).[`injector`](BaseRemoteMethod.md#injector-1)
|
|
144
|
+
|
|
145
|
+
***
|
|
146
|
+
|
|
147
|
+
### interceptors
|
|
148
|
+
|
|
149
|
+
> `readonly` **interceptors**: `undefined` \| `Set`\<`Subject`\<`any`\>\>
|
|
150
|
+
|
|
151
|
+
Defined in: [packages/angular/definition/src/lib/definition.ts:53](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/definition/src/lib/definition.ts#L53)
|
|
152
|
+
|
|
153
|
+
#### Inherited from
|
|
154
|
+
|
|
155
|
+
[`BaseRemoteMethod`](BaseRemoteMethod.md).[`interceptors`](BaseRemoteMethod.md#interceptors)
|
|
156
|
+
|
|
157
|
+
***
|
|
158
|
+
|
|
159
|
+
### metadata
|
|
160
|
+
|
|
161
|
+
> **metadata**: [`BaseRemoteMethodMetadata`](../interfaces/BaseRemoteMethodMetadata.md)
|
|
162
|
+
|
|
163
|
+
Defined in: [packages/angular/definition/src/lib/definition.ts:44](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/definition/src/lib/definition.ts#L44)
|
|
164
|
+
|
|
165
|
+
#### Inherited from
|
|
166
|
+
|
|
167
|
+
[`BaseRemoteMethod`](BaseRemoteMethod.md).[`metadata`](BaseRemoteMethod.md#metadata-1)
|
|
168
|
+
|
|
169
|
+
***
|
|
170
|
+
|
|
171
|
+
### destroyed$
|
|
172
|
+
|
|
173
|
+
> `readonly` `static` **destroyed$**: `Subject`\<`BaseDefinition`\<`BaseDefinitionMetadata`\>\>
|
|
174
|
+
|
|
175
|
+
Defined in: [packages/angular/definition/src/lib/definition.ts:41](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/definition/src/lib/definition.ts#L41)
|
|
176
|
+
|
|
177
|
+
Emits when a new Definition instance is initialised
|
|
178
|
+
|
|
179
|
+
#### Inherited from
|
|
180
|
+
|
|
181
|
+
[`BaseRemoteMethod`](BaseRemoteMethod.md).[`destroyed$`](BaseRemoteMethod.md#destroyed$-1)
|
|
182
|
+
|
|
183
|
+
***
|
|
184
|
+
|
|
185
|
+
### initialised$
|
|
186
|
+
|
|
187
|
+
> `readonly` `static` **initialised$**: `Subject`\<`BaseDefinition`\<`BaseDefinitionMetadata`\>\>
|
|
188
|
+
|
|
189
|
+
Defined in: [packages/angular/definition/src/lib/definition.ts:35](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/definition/src/lib/definition.ts#L35)
|
|
190
|
+
|
|
191
|
+
Emits when a new Definition instance is initialised
|
|
192
|
+
|
|
193
|
+
#### Inherited from
|
|
194
|
+
|
|
195
|
+
[`BaseRemoteMethod`](BaseRemoteMethod.md).[`initialised$`](BaseRemoteMethod.md#initialised$-1)
|
|
196
|
+
|
|
197
|
+
***
|
|
198
|
+
|
|
199
|
+
### instances
|
|
200
|
+
|
|
201
|
+
> `readonly` `static` **instances**: `Map`\<`string`, `BaseDefinition`\<`BaseDefinitionMetadata`\>\>
|
|
202
|
+
|
|
203
|
+
Defined in: [packages/angular/definition/src/lib/definition.ts:27](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/definition/src/lib/definition.ts#L27)
|
|
204
|
+
|
|
205
|
+
A map of active Definition instances
|
|
206
|
+
|
|
207
|
+
#### Inherited from
|
|
208
|
+
|
|
209
|
+
[`BaseRemoteMethod`](BaseRemoteMethod.md).[`instances`](BaseRemoteMethod.md#instances)
|
|
210
|
+
|
|
211
|
+
## Accessors
|
|
212
|
+
|
|
213
|
+
### id
|
|
214
|
+
|
|
215
|
+
#### Get Signature
|
|
216
|
+
|
|
217
|
+
> **get** **id**(): `string`
|
|
218
|
+
|
|
219
|
+
Defined in: [packages/angular/definition/src/lib/definition.ts:87](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/definition/src/lib/definition.ts#L87)
|
|
220
|
+
|
|
221
|
+
##### Returns
|
|
222
|
+
|
|
223
|
+
`string`
|
|
224
|
+
|
|
225
|
+
#### Inherited from
|
|
226
|
+
|
|
227
|
+
[`BaseRemoteMethod`](BaseRemoteMethod.md).[`id`](BaseRemoteMethod.md#id)
|
|
228
|
+
|
|
229
|
+
## Methods
|
|
230
|
+
|
|
231
|
+
### \_call()
|
|
232
|
+
|
|
233
|
+
> `protected` **\_call**(`parameters`?): `Promise`\<`any`\>
|
|
234
|
+
|
|
235
|
+
Defined in: [packages/angular/remote-method/src/lib/proxy.remote-method.ts:33](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/remote-method/src/lib/proxy.remote-method.ts#L33)
|
|
236
|
+
|
|
237
|
+
#### Parameters
|
|
238
|
+
|
|
239
|
+
##### parameters?
|
|
240
|
+
|
|
241
|
+
`SourceParameter`
|
|
242
|
+
|
|
243
|
+
#### Returns
|
|
244
|
+
|
|
245
|
+
`Promise`\<`any`\>
|
|
246
|
+
|
|
247
|
+
#### Overrides
|
|
248
|
+
|
|
249
|
+
[`BaseRemoteMethod`](BaseRemoteMethod.md).[`_call`](BaseRemoteMethod.md#_call)
|
|
250
|
+
|
|
251
|
+
***
|
|
252
|
+
|
|
253
|
+
### applyMetadata()
|
|
254
|
+
|
|
255
|
+
> **applyMetadata**(`partialMetadata`): `void`
|
|
256
|
+
|
|
257
|
+
Defined in: [packages/angular/definition/src/lib/definition.ts:111](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/definition/src/lib/definition.ts#L111)
|
|
258
|
+
|
|
259
|
+
#### Parameters
|
|
260
|
+
|
|
261
|
+
##### partialMetadata
|
|
262
|
+
|
|
263
|
+
`Partial`\<[`BaseRemoteMethodMetadata`](../interfaces/BaseRemoteMethodMetadata.md)\>
|
|
264
|
+
|
|
265
|
+
#### Returns
|
|
266
|
+
|
|
267
|
+
`void`
|
|
268
|
+
|
|
269
|
+
#### Inherited from
|
|
270
|
+
|
|
271
|
+
[`BaseRemoteMethod`](BaseRemoteMethod.md).[`applyMetadata`](BaseRemoteMethod.md#applymetadata)
|
|
272
|
+
|
|
273
|
+
***
|
|
274
|
+
|
|
275
|
+
### call()
|
|
276
|
+
|
|
277
|
+
> **call**(`parameters`?): `Promise`\<`ReturnType`\>
|
|
278
|
+
|
|
279
|
+
Defined in: [packages/angular/remote-method/src/lib/base.remote-method.ts:76](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/remote-method/src/lib/base.remote-method.ts#L76)
|
|
280
|
+
|
|
281
|
+
#### Parameters
|
|
282
|
+
|
|
283
|
+
##### parameters?
|
|
284
|
+
|
|
285
|
+
`SourceParameter`
|
|
286
|
+
|
|
287
|
+
#### Returns
|
|
288
|
+
|
|
289
|
+
`Promise`\<`ReturnType`\>
|
|
290
|
+
|
|
291
|
+
#### Inherited from
|
|
292
|
+
|
|
293
|
+
[`BaseRemoteMethod`](BaseRemoteMethod.md).[`call`](BaseRemoteMethod.md#call)
|
|
294
|
+
|
|
295
|
+
***
|
|
296
|
+
|
|
297
|
+
### ~~destroy()~~
|
|
298
|
+
|
|
299
|
+
> **destroy**(): `void`
|
|
300
|
+
|
|
301
|
+
Defined in: [packages/angular/definition/src/lib/definition.ts:118](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/definition/src/lib/definition.ts#L118)
|
|
302
|
+
|
|
303
|
+
#### Returns
|
|
304
|
+
|
|
305
|
+
`void`
|
|
306
|
+
|
|
307
|
+
#### Deprecated
|
|
308
|
+
|
|
309
|
+
use ngOnDestroy instead
|
|
310
|
+
|
|
311
|
+
#### Inherited from
|
|
312
|
+
|
|
313
|
+
[`BaseRemoteMethod`](BaseRemoteMethod.md).[`destroy`](BaseRemoteMethod.md#destroy)
|
|
314
|
+
|
|
315
|
+
***
|
|
316
|
+
|
|
317
|
+
### executed()
|
|
318
|
+
|
|
319
|
+
> **executed**(`result`): `void`
|
|
320
|
+
|
|
321
|
+
Defined in: [packages/angular/remote-method/src/lib/base.remote-method.ts:86](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/remote-method/src/lib/base.remote-method.ts#L86)
|
|
322
|
+
|
|
323
|
+
#### Parameters
|
|
324
|
+
|
|
325
|
+
##### result
|
|
326
|
+
|
|
327
|
+
`ReturnType`
|
|
328
|
+
|
|
329
|
+
#### Returns
|
|
330
|
+
|
|
331
|
+
`void`
|
|
332
|
+
|
|
333
|
+
#### Inherited from
|
|
334
|
+
|
|
335
|
+
[`BaseRemoteMethod`](BaseRemoteMethod.md).[`executed`](BaseRemoteMethod.md#executed)
|
|
336
|
+
|
|
337
|
+
***
|
|
338
|
+
|
|
339
|
+
### getMetadata()
|
|
340
|
+
|
|
341
|
+
> **getMetadata**(): `null` \| [`BaseRemoteMethodMetadata`](../interfaces/BaseRemoteMethodMetadata.md)
|
|
342
|
+
|
|
343
|
+
Defined in: [packages/angular/definition/src/lib/definition.ts:107](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/definition/src/lib/definition.ts#L107)
|
|
344
|
+
|
|
345
|
+
#### Returns
|
|
346
|
+
|
|
347
|
+
`null` \| [`BaseRemoteMethodMetadata`](../interfaces/BaseRemoteMethodMetadata.md)
|
|
348
|
+
|
|
349
|
+
#### Inherited from
|
|
350
|
+
|
|
351
|
+
[`BaseRemoteMethod`](BaseRemoteMethod.md).[`getMetadata`](BaseRemoteMethod.md#getmetadata)
|
|
352
|
+
|
|
353
|
+
***
|
|
354
|
+
|
|
355
|
+
### init()
|
|
356
|
+
|
|
357
|
+
> **init**(): `void`
|
|
358
|
+
|
|
359
|
+
Defined in: [packages/angular/definition/src/lib/definition.ts:127](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/definition/src/lib/definition.ts#L127)
|
|
360
|
+
|
|
361
|
+
#### Returns
|
|
362
|
+
|
|
363
|
+
`void`
|
|
364
|
+
|
|
365
|
+
#### Inherited from
|
|
366
|
+
|
|
367
|
+
[`BaseRemoteMethod`](BaseRemoteMethod.md).[`init`](BaseRemoteMethod.md#init)
|
|
368
|
+
|
|
369
|
+
***
|
|
370
|
+
|
|
371
|
+
### ngOnDestroy()
|
|
372
|
+
|
|
373
|
+
> **ngOnDestroy**(): `void`
|
|
374
|
+
|
|
375
|
+
Defined in: [packages/angular/definition/src/lib/definition.ts:122](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/definition/src/lib/definition.ts#L122)
|
|
376
|
+
|
|
377
|
+
A callback method that performs custom clean-up, invoked immediately
|
|
378
|
+
before a directive, pipe, or service instance is destroyed.
|
|
379
|
+
|
|
380
|
+
#### Returns
|
|
381
|
+
|
|
382
|
+
`void`
|
|
383
|
+
|
|
384
|
+
#### Inherited from
|
|
385
|
+
|
|
386
|
+
[`BaseRemoteMethod`](BaseRemoteMethod.md).[`ngOnDestroy`](BaseRemoteMethod.md#ngondestroy)
|
|
387
|
+
|
|
388
|
+
***
|
|
389
|
+
|
|
390
|
+
### pauseRefresh()
|
|
391
|
+
|
|
392
|
+
> **pauseRefresh**(): `void`
|
|
393
|
+
|
|
394
|
+
Defined in: [packages/angular/remote-method/src/lib/base.remote-method.ts:92](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/remote-method/src/lib/base.remote-method.ts#L92)
|
|
395
|
+
|
|
396
|
+
#### Returns
|
|
397
|
+
|
|
398
|
+
`void`
|
|
399
|
+
|
|
400
|
+
#### Inherited from
|
|
401
|
+
|
|
402
|
+
[`BaseRemoteMethod`](BaseRemoteMethod.md).[`pauseRefresh`](BaseRemoteMethod.md#pauserefresh)
|
|
403
|
+
|
|
404
|
+
***
|
|
405
|
+
|
|
406
|
+
### refresh()
|
|
407
|
+
|
|
408
|
+
> **refresh**(): `void`
|
|
409
|
+
|
|
410
|
+
Defined in: [packages/angular/remote-method/src/lib/base.remote-method.ts:100](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/remote-method/src/lib/base.remote-method.ts#L100)
|
|
411
|
+
|
|
412
|
+
#### Returns
|
|
413
|
+
|
|
414
|
+
`void`
|
|
415
|
+
|
|
416
|
+
#### Inherited from
|
|
417
|
+
|
|
418
|
+
[`BaseRemoteMethod`](BaseRemoteMethod.md).[`refresh`](BaseRemoteMethod.md#refresh)
|
|
419
|
+
|
|
420
|
+
***
|
|
421
|
+
|
|
422
|
+
### resumeRefresh()
|
|
423
|
+
|
|
424
|
+
> **resumeRefresh**(): `void`
|
|
425
|
+
|
|
426
|
+
Defined in: [packages/angular/remote-method/src/lib/base.remote-method.ts:96](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/remote-method/src/lib/base.remote-method.ts#L96)
|
|
427
|
+
|
|
428
|
+
#### Returns
|
|
429
|
+
|
|
430
|
+
`void`
|
|
431
|
+
|
|
432
|
+
#### Inherited from
|
|
433
|
+
|
|
434
|
+
[`BaseRemoteMethod`](BaseRemoteMethod.md).[`resumeRefresh`](BaseRemoteMethod.md#resumerefresh)
|
|
435
|
+
|
|
436
|
+
***
|
|
437
|
+
|
|
438
|
+
### transformParameters()
|
|
439
|
+
|
|
440
|
+
> `abstract` **transformParameters**(`parameters`?): `TargetParameter` \| `Promise`\<`TargetParameter`\>
|
|
441
|
+
|
|
442
|
+
Defined in: [packages/angular/remote-method/src/lib/proxy.remote-method.ts:31](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/remote-method/src/lib/proxy.remote-method.ts#L31)
|
|
443
|
+
|
|
444
|
+
#### Parameters
|
|
445
|
+
|
|
446
|
+
##### parameters?
|
|
447
|
+
|
|
448
|
+
`SourceParameter`
|
|
449
|
+
|
|
450
|
+
#### Returns
|
|
451
|
+
|
|
452
|
+
`TargetParameter` \| `Promise`\<`TargetParameter`\>
|
|
453
|
+
|
|
454
|
+
***
|
|
455
|
+
|
|
456
|
+
### add()
|
|
457
|
+
|
|
458
|
+
> `static` **add**(`definition`): `void`
|
|
459
|
+
|
|
460
|
+
Defined in: [packages/angular/definition/src/lib/definition.ts:94](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/definition/src/lib/definition.ts#L94)
|
|
461
|
+
|
|
462
|
+
#### Parameters
|
|
463
|
+
|
|
464
|
+
##### definition
|
|
465
|
+
|
|
466
|
+
`BaseDefinition`
|
|
467
|
+
|
|
468
|
+
#### Returns
|
|
469
|
+
|
|
470
|
+
`void`
|
|
471
|
+
|
|
472
|
+
#### Inherited from
|
|
473
|
+
|
|
474
|
+
[`BaseRemoteMethod`](BaseRemoteMethod.md).[`add`](BaseRemoteMethod.md#add)
|
|
475
|
+
|
|
476
|
+
***
|
|
477
|
+
|
|
478
|
+
### remove()
|
|
479
|
+
|
|
480
|
+
> `static` **remove**(`definition`): `void`
|
|
481
|
+
|
|
482
|
+
Defined in: [packages/angular/definition/src/lib/definition.ts:102](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/definition/src/lib/definition.ts#L102)
|
|
483
|
+
|
|
484
|
+
#### Parameters
|
|
485
|
+
|
|
486
|
+
##### definition
|
|
487
|
+
|
|
488
|
+
`BaseDefinition`
|
|
489
|
+
|
|
490
|
+
#### Returns
|
|
491
|
+
|
|
492
|
+
`void`
|
|
493
|
+
|
|
494
|
+
#### Inherited from
|
|
495
|
+
|
|
496
|
+
[`BaseRemoteMethod`](BaseRemoteMethod.md).[`remove`](BaseRemoteMethod.md#remove)
|
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
[**@rxap/remote-method**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@rxap/remote-method](../globals.md) / RemoteMethodLoader
|
|
6
|
+
|
|
7
|
+
# Class: RemoteMethodLoader
|
|
8
|
+
|
|
9
|
+
Defined in: [packages/angular/remote-method/src/lib/remote-method-loader.ts:16](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/remote-method/src/lib/remote-method-loader.ts#L16)
|
|
10
|
+
|
|
11
|
+
## Extends
|
|
12
|
+
|
|
13
|
+
- `DefinitionLoader`
|
|
14
|
+
|
|
15
|
+
## Constructors
|
|
16
|
+
|
|
17
|
+
### new RemoteMethodLoader()
|
|
18
|
+
|
|
19
|
+
> **new RemoteMethodLoader**(`injector`): [`RemoteMethodLoader`](RemoteMethodLoader.md)
|
|
20
|
+
|
|
21
|
+
Defined in: [packages/angular/definition/src/lib/definition.loader.ts:15](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/definition/src/lib/definition.loader.ts#L15)
|
|
22
|
+
|
|
23
|
+
#### Parameters
|
|
24
|
+
|
|
25
|
+
##### injector
|
|
26
|
+
|
|
27
|
+
`Injector`
|
|
28
|
+
|
|
29
|
+
#### Returns
|
|
30
|
+
|
|
31
|
+
[`RemoteMethodLoader`](RemoteMethodLoader.md)
|
|
32
|
+
|
|
33
|
+
#### Inherited from
|
|
34
|
+
|
|
35
|
+
`DefinitionLoader.constructor`
|
|
36
|
+
|
|
37
|
+
## Methods
|
|
38
|
+
|
|
39
|
+
### call$()
|
|
40
|
+
|
|
41
|
+
> **call$**\<`ReturnType`, `Parameters`, `Metadata`\>(`remoteMethodIdOrInstanceOrToken`, `parameters`, `metadata`?, `injector`?, `notFoundValue`?, `flags`?): `Promise`\<`ReturnType`\>
|
|
42
|
+
|
|
43
|
+
Defined in: [packages/angular/remote-method/src/lib/remote-method-loader.ts:18](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/remote-method/src/lib/remote-method-loader.ts#L18)
|
|
44
|
+
|
|
45
|
+
#### Type Parameters
|
|
46
|
+
|
|
47
|
+
• **ReturnType** = `any`
|
|
48
|
+
|
|
49
|
+
• **Parameters** = `any`
|
|
50
|
+
|
|
51
|
+
• **Metadata** *extends* [`BaseRemoteMethodMetadata`](../interfaces/BaseRemoteMethodMetadata.md) = [`BaseRemoteMethodMetadata`](../interfaces/BaseRemoteMethodMetadata.md)
|
|
52
|
+
|
|
53
|
+
#### Parameters
|
|
54
|
+
|
|
55
|
+
##### remoteMethodIdOrInstanceOrToken
|
|
56
|
+
|
|
57
|
+
`IdOrInstanceOrToken`\<[`BaseRemoteMethod`](BaseRemoteMethod.md)\<`ReturnType`, `Parameters`, `Metadata`\>\>
|
|
58
|
+
|
|
59
|
+
##### parameters
|
|
60
|
+
|
|
61
|
+
`Parameters`
|
|
62
|
+
|
|
63
|
+
##### metadata?
|
|
64
|
+
|
|
65
|
+
`Partial`\<[`BaseRemoteMethodMetadata`](../interfaces/BaseRemoteMethodMetadata.md)\>
|
|
66
|
+
|
|
67
|
+
##### injector?
|
|
68
|
+
|
|
69
|
+
`Injector`
|
|
70
|
+
|
|
71
|
+
##### notFoundValue?
|
|
72
|
+
|
|
73
|
+
[`BaseRemoteMethod`](BaseRemoteMethod.md)\<`ReturnType`, `Parameters`, `Metadata`\>
|
|
74
|
+
|
|
75
|
+
##### flags?
|
|
76
|
+
|
|
77
|
+
`InjectFlags`
|
|
78
|
+
|
|
79
|
+
#### Returns
|
|
80
|
+
|
|
81
|
+
`Promise`\<`ReturnType`\>
|
|
82
|
+
|
|
83
|
+
***
|
|
84
|
+
|
|
85
|
+
### load()
|
|
86
|
+
|
|
87
|
+
> **load**\<`Definition`\>(`definitionIdOrInstanceOrInjectionToken`, `metadata`?, `injector`?, `notFoundValue`?, `flags`?): `Definition`
|
|
88
|
+
|
|
89
|
+
Defined in: [packages/angular/definition/src/lib/definition.loader.ts:21](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/definition/src/lib/definition.loader.ts#L21)
|
|
90
|
+
|
|
91
|
+
#### Type Parameters
|
|
92
|
+
|
|
93
|
+
• **Definition** *extends* `BaseDefinition`\<`BaseDefinitionMetadata`\>
|
|
94
|
+
|
|
95
|
+
#### Parameters
|
|
96
|
+
|
|
97
|
+
##### definitionIdOrInstanceOrInjectionToken
|
|
98
|
+
|
|
99
|
+
`IdOrInstanceOrToken`\<`Definition`\>
|
|
100
|
+
|
|
101
|
+
##### metadata?
|
|
102
|
+
|
|
103
|
+
`Partial`\<`BaseDefinitionMetadata`\>
|
|
104
|
+
|
|
105
|
+
##### injector?
|
|
106
|
+
|
|
107
|
+
`Injector` = `...`
|
|
108
|
+
|
|
109
|
+
##### notFoundValue?
|
|
110
|
+
|
|
111
|
+
`Definition`
|
|
112
|
+
|
|
113
|
+
##### flags?
|
|
114
|
+
|
|
115
|
+
`InjectFlags`
|
|
116
|
+
|
|
117
|
+
#### Returns
|
|
118
|
+
|
|
119
|
+
`Definition`
|
|
120
|
+
|
|
121
|
+
#### Inherited from
|
|
122
|
+
|
|
123
|
+
`DefinitionLoader.load`
|