@rxap/remote-method 19.0.1-dev.4 → 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 +4 -0
  2. package/README.md +24 -26
  3. package/compodoc/changelog.html +2 -0
  4. package/compodoc/dependencies.html +3 -3
  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 +15 -14
  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,438 @@
1
+ [@rxap/remote-method](../wiki/globals) / BaseRemoteMethod
2
+
3
+ # Class: `abstract` BaseRemoteMethod\<ReturnType, Parameter, Metadata\>
4
+
5
+ Defined in: [packages/angular/remote-method/src/lib/base.remote-method.ts:38](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/remote-method/src/lib/base.remote-method.ts#L38)
6
+
7
+ ## Extends
8
+
9
+ - `BaseDefinition`\<`Metadata`\>
10
+
11
+ ## Extended by
12
+
13
+ - [`ProxyRemoteMethod`](../wiki/Class.ProxyRemoteMethod)
14
+
15
+ ## Type Parameters
16
+
17
+ • **ReturnType** = `any`
18
+
19
+ • **Parameter** = `any`
20
+
21
+ • **Metadata** *extends* [`BaseRemoteMethodMetadata`](../wiki/Interface.BaseRemoteMethodMetadata) = [`BaseRemoteMethodMetadata`](../wiki/Interface.BaseRemoteMethodMetadata)
22
+
23
+ ## Constructors
24
+
25
+ ### new BaseRemoteMethod()
26
+
27
+ > **new BaseRemoteMethod**\<`ReturnType`, `Parameter`, `Metadata`\>(`injector`, `metaData`): [`BaseRemoteMethod`](../wiki/Class.BaseRemoteMethod)\<`ReturnType`, `Parameter`, `Metadata`\>
28
+
29
+ Defined in: [packages/angular/remote-method/src/lib/base.remote-method.ts:50](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/remote-method/src/lib/base.remote-method.ts#L50)
30
+
31
+ #### Parameters
32
+
33
+ ##### injector
34
+
35
+ `null` | `Injector`
36
+
37
+ ##### metaData
38
+
39
+ `any` = `null`
40
+
41
+ #### Returns
42
+
43
+ [`BaseRemoteMethod`](../wiki/Class.BaseRemoteMethod)\<`ReturnType`, `Parameter`, `Metadata`\>
44
+
45
+ #### Overrides
46
+
47
+ `BaseDefinition<Metadata>.constructor`
48
+
49
+ ## Properties
50
+
51
+ ### \_\_id
52
+
53
+ > **\_\_id**: `string`
54
+
55
+ 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)
56
+
57
+ **`Internal`**
58
+
59
+ unique internal id
60
+
61
+ #### Inherited from
62
+
63
+ `BaseDefinition.__id`
64
+
65
+ ***
66
+
67
+ ### \_initialised
68
+
69
+ > `protected` **\_initialised**: `boolean` = `false`
70
+
71
+ 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)
72
+
73
+ #### Inherited from
74
+
75
+ `BaseDefinition._initialised`
76
+
77
+ ***
78
+
79
+ ### destroyed$
80
+
81
+ > `readonly` **destroyed$**: `undefined` \| `Subject`\<`void`\>
82
+
83
+ 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)
84
+
85
+ Emits if the data source is destroyed
86
+
87
+ #### Inherited from
88
+
89
+ `BaseDefinition.destroyed$`
90
+
91
+ ***
92
+
93
+ ### executed$
94
+
95
+ > **executed$**: `Subject`\<`ReturnType`\>
96
+
97
+ 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)
98
+
99
+ ***
100
+
101
+ ### executionsInProgress$
102
+
103
+ > **executionsInProgress$**: `CounterSubject`
104
+
105
+ 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)
106
+
107
+ ***
108
+
109
+ ### initialised$
110
+
111
+ > `readonly` **initialised$**: `undefined` \| `Subject`\<`void`\>
112
+
113
+ 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)
114
+
115
+ Emits if the data source is initialised
116
+
117
+ #### Inherited from
118
+
119
+ `BaseDefinition.initialised$`
120
+
121
+ ***
122
+
123
+ ### injector
124
+
125
+ > `readonly` **injector**: `Injector`
126
+
127
+ 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)
128
+
129
+ ***
130
+
131
+ ### interceptors
132
+
133
+ > `readonly` **interceptors**: `undefined` \| `Set`\<`Subject`\<`any`\>\>
134
+
135
+ 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)
136
+
137
+ #### Inherited from
138
+
139
+ `BaseDefinition.interceptors`
140
+
141
+ ***
142
+
143
+ ### metadata
144
+
145
+ > **metadata**: `Metadata`
146
+
147
+ 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)
148
+
149
+ #### Inherited from
150
+
151
+ `BaseDefinition.metadata`
152
+
153
+ ***
154
+
155
+ ### destroyed$
156
+
157
+ > `readonly` `static` **destroyed$**: `Subject`\<`BaseDefinition`\<`BaseDefinitionMetadata`\>\>
158
+
159
+ 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)
160
+
161
+ Emits when a new Definition instance is initialised
162
+
163
+ #### Inherited from
164
+
165
+ `BaseDefinition.destroyed$`
166
+
167
+ ***
168
+
169
+ ### initialised$
170
+
171
+ > `readonly` `static` **initialised$**: `Subject`\<`BaseDefinition`\<`BaseDefinitionMetadata`\>\>
172
+
173
+ 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)
174
+
175
+ Emits when a new Definition instance is initialised
176
+
177
+ #### Inherited from
178
+
179
+ `BaseDefinition.initialised$`
180
+
181
+ ***
182
+
183
+ ### instances
184
+
185
+ > `readonly` `static` **instances**: `Map`\<`string`, `BaseDefinition`\<`BaseDefinitionMetadata`\>\>
186
+
187
+ 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)
188
+
189
+ A map of active Definition instances
190
+
191
+ #### Inherited from
192
+
193
+ `BaseDefinition.instances`
194
+
195
+ ## Accessors
196
+
197
+ ### id
198
+
199
+ #### Get Signature
200
+
201
+ > **get** **id**(): `string`
202
+
203
+ 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)
204
+
205
+ ##### Returns
206
+
207
+ `string`
208
+
209
+ #### Inherited from
210
+
211
+ `BaseDefinition.id`
212
+
213
+ ## Methods
214
+
215
+ ### \_call()
216
+
217
+ > `abstract` `protected` **\_call**(`parameters`?): `ReturnType` \| `Promise`\<`ReturnType`\>
218
+
219
+ Defined in: [packages/angular/remote-method/src/lib/base.remote-method.ts:111](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/remote-method/src/lib/base.remote-method.ts#L111)
220
+
221
+ #### Parameters
222
+
223
+ ##### parameters?
224
+
225
+ `Parameter`
226
+
227
+ #### Returns
228
+
229
+ `ReturnType` \| `Promise`\<`ReturnType`\>
230
+
231
+ ***
232
+
233
+ ### applyMetadata()
234
+
235
+ > **applyMetadata**(`partialMetadata`): `void`
236
+
237
+ 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)
238
+
239
+ #### Parameters
240
+
241
+ ##### partialMetadata
242
+
243
+ `Partial`\<`Metadata`\>
244
+
245
+ #### Returns
246
+
247
+ `void`
248
+
249
+ #### Inherited from
250
+
251
+ `BaseDefinition.applyMetadata`
252
+
253
+ ***
254
+
255
+ ### call()
256
+
257
+ > **call**(`parameters`?): `Promise`\<`ReturnType`\>
258
+
259
+ 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)
260
+
261
+ #### Parameters
262
+
263
+ ##### parameters?
264
+
265
+ `Parameter`
266
+
267
+ #### Returns
268
+
269
+ `Promise`\<`ReturnType`\>
270
+
271
+ ***
272
+
273
+ ### ~~destroy()~~
274
+
275
+ > **destroy**(): `void`
276
+
277
+ 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)
278
+
279
+ #### Returns
280
+
281
+ `void`
282
+
283
+ #### Deprecated
284
+
285
+ use ngOnDestroy instead
286
+
287
+ #### Inherited from
288
+
289
+ `BaseDefinition.destroy`
290
+
291
+ ***
292
+
293
+ ### executed()
294
+
295
+ > **executed**(`result`): `void`
296
+
297
+ 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)
298
+
299
+ #### Parameters
300
+
301
+ ##### result
302
+
303
+ `ReturnType`
304
+
305
+ #### Returns
306
+
307
+ `void`
308
+
309
+ ***
310
+
311
+ ### getMetadata()
312
+
313
+ > **getMetadata**(): `null` \| `Metadata`
314
+
315
+ 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)
316
+
317
+ #### Returns
318
+
319
+ `null` \| `Metadata`
320
+
321
+ #### Inherited from
322
+
323
+ `BaseDefinition.getMetadata`
324
+
325
+ ***
326
+
327
+ ### init()
328
+
329
+ > **init**(): `void`
330
+
331
+ 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)
332
+
333
+ #### Returns
334
+
335
+ `void`
336
+
337
+ #### Inherited from
338
+
339
+ `BaseDefinition.init`
340
+
341
+ ***
342
+
343
+ ### ngOnDestroy()
344
+
345
+ > **ngOnDestroy**(): `void`
346
+
347
+ 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)
348
+
349
+ A callback method that performs custom clean-up, invoked immediately
350
+ before a directive, pipe, or service instance is destroyed.
351
+
352
+ #### Returns
353
+
354
+ `void`
355
+
356
+ #### Inherited from
357
+
358
+ `BaseDefinition.ngOnDestroy`
359
+
360
+ ***
361
+
362
+ ### pauseRefresh()
363
+
364
+ > **pauseRefresh**(): `void`
365
+
366
+ 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)
367
+
368
+ #### Returns
369
+
370
+ `void`
371
+
372
+ ***
373
+
374
+ ### refresh()
375
+
376
+ > **refresh**(): `void`
377
+
378
+ 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)
379
+
380
+ #### Returns
381
+
382
+ `void`
383
+
384
+ ***
385
+
386
+ ### resumeRefresh()
387
+
388
+ > **resumeRefresh**(): `void`
389
+
390
+ 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)
391
+
392
+ #### Returns
393
+
394
+ `void`
395
+
396
+ ***
397
+
398
+ ### add()
399
+
400
+ > `static` **add**(`definition`): `void`
401
+
402
+ 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)
403
+
404
+ #### Parameters
405
+
406
+ ##### definition
407
+
408
+ `BaseDefinition`
409
+
410
+ #### Returns
411
+
412
+ `void`
413
+
414
+ #### Inherited from
415
+
416
+ `BaseDefinition.add`
417
+
418
+ ***
419
+
420
+ ### remove()
421
+
422
+ > `static` **remove**(`definition`): `void`
423
+
424
+ 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)
425
+
426
+ #### Parameters
427
+
428
+ ##### definition
429
+
430
+ `BaseDefinition`
431
+
432
+ #### Returns
433
+
434
+ `void`
435
+
436
+ #### Inherited from
437
+
438
+ `BaseDefinition.remove`