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