@arrai-innovations/reactive-helpers 13.0.1 → 13.0.3
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/config/listCrud.js +55 -2
- package/config/objectCrud.js +62 -6
- package/docs/config/listCrud.md +163 -4
- package/docs/config/objectCrud.md +234 -12
- package/docs/use/combineClasses.md +9 -1
- package/docs/use/listInstance.md +10 -2
- package/docs/use/loadingError.md +71 -3
- package/docs/use/object.md +120 -24
- package/docs/use/objectCalculated.md +120 -24
- package/docs/use/objectInstance.md +120 -24
- package/docs/use/objectRelated.md +120 -24
- package/docs/use/objectSubscription.md +60 -12
- package/index.js +1 -0
- package/package.json +1 -1
- package/use/combineClasses.js +10 -6
- package/use/listInstance.js +5 -2
- package/use/listSubscription.js +1 -1
- package/use/loadingError.js +14 -7
- package/use/objectInstance.js +1 -1
- package/use/objectSubscription.js +1 -1
package/docs/use/loadingError.md
CHANGED
|
@@ -6,16 +6,84 @@
|
|
|
6
6
|
|
|
7
7
|
# use/loadingError
|
|
8
8
|
|
|
9
|
+
## Interfaces
|
|
10
|
+
|
|
11
|
+
### LoadingError
|
|
12
|
+
|
|
13
|
+
#### Properties
|
|
14
|
+
|
|
15
|
+
##### clearError()
|
|
16
|
+
|
|
17
|
+
> **clearError**: () => `void`
|
|
18
|
+
|
|
19
|
+
Clear the error state.
|
|
20
|
+
|
|
21
|
+
###### Returns
|
|
22
|
+
|
|
23
|
+
`void`
|
|
24
|
+
|
|
25
|
+
##### clearLoading()
|
|
26
|
+
|
|
27
|
+
> **clearLoading**: () => `void`
|
|
28
|
+
|
|
29
|
+
Clear the loading state.
|
|
30
|
+
|
|
31
|
+
###### Returns
|
|
32
|
+
|
|
33
|
+
`void`
|
|
34
|
+
|
|
35
|
+
##### error
|
|
36
|
+
|
|
37
|
+
> **error**: `Readonly`\<`Ref`\<`Error`\>\>
|
|
38
|
+
|
|
39
|
+
The error that occurred.
|
|
40
|
+
|
|
41
|
+
##### errored
|
|
42
|
+
|
|
43
|
+
> **errored**: `Readonly`\<`Ref`\<`boolean`\>\>
|
|
44
|
+
|
|
45
|
+
Whether an error has occurred.
|
|
46
|
+
|
|
47
|
+
##### loading
|
|
48
|
+
|
|
49
|
+
> **loading**: `Readonly`\<`Ref`\<`boolean`\>\>
|
|
50
|
+
|
|
51
|
+
Whether the component is loading.
|
|
52
|
+
|
|
53
|
+
##### setError()
|
|
54
|
+
|
|
55
|
+
> **setError**: (`error`) => `void`
|
|
56
|
+
|
|
57
|
+
Set the error state.
|
|
58
|
+
|
|
59
|
+
###### Parameters
|
|
60
|
+
|
|
61
|
+
• **error**: `any`
|
|
62
|
+
|
|
63
|
+
###### Returns
|
|
64
|
+
|
|
65
|
+
`void`
|
|
66
|
+
|
|
67
|
+
##### setLoading()
|
|
68
|
+
|
|
69
|
+
> **setLoading**: () => `void`
|
|
70
|
+
|
|
71
|
+
Set the loading state.
|
|
72
|
+
|
|
73
|
+
###### Returns
|
|
74
|
+
|
|
75
|
+
`void`
|
|
76
|
+
|
|
9
77
|
## Functions
|
|
10
78
|
|
|
11
|
-
###
|
|
79
|
+
### useLoadingError()
|
|
12
80
|
|
|
13
|
-
> **
|
|
81
|
+
> **useLoadingError**(): [`LoadingError`](loadingError.md#loadingerror)
|
|
14
82
|
|
|
15
83
|
A composable function for managing loading and error states.
|
|
16
84
|
|
|
17
85
|
#### Returns
|
|
18
86
|
|
|
19
|
-
`
|
|
87
|
+
[`LoadingError`](loadingError.md#loadingerror)
|
|
20
88
|
|
|
21
89
|
- An object containing reactive fields and actions for loading and error states.
|
package/docs/use/object.md
CHANGED
|
@@ -42,42 +42,90 @@ The arguments to be passed to the crud functions.
|
|
|
42
42
|
|
|
43
43
|
The arguments to be passed to the crud functions.
|
|
44
44
|
|
|
45
|
-
###### crudArgs.create
|
|
45
|
+
###### crudArgs.create()
|
|
46
46
|
|
|
47
|
-
> **create**: `
|
|
47
|
+
> **create**: (`CreateDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
|
|
48
48
|
|
|
49
49
|
A function to be used instead of the default crud create function.
|
|
50
50
|
|
|
51
|
-
######
|
|
51
|
+
###### Parameters
|
|
52
52
|
|
|
53
|
-
|
|
53
|
+
• **CreateDetailArgs**: `any`
|
|
54
|
+
|
|
55
|
+
###### Returns
|
|
56
|
+
|
|
57
|
+
[`ResponseData`](../config/objectCrud.md#responsedata)
|
|
58
|
+
|
|
59
|
+
###### crudArgs.delete()
|
|
60
|
+
|
|
61
|
+
> **delete**: (`DeleteDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
|
|
54
62
|
|
|
55
63
|
A function to be used instead of the default crud delete function.
|
|
56
64
|
|
|
57
|
-
######
|
|
65
|
+
###### Parameters
|
|
66
|
+
|
|
67
|
+
• **DeleteDetailArgs**: `any`
|
|
68
|
+
|
|
69
|
+
###### Returns
|
|
58
70
|
|
|
59
|
-
|
|
71
|
+
[`ResponseData`](../config/objectCrud.md#responsedata)
|
|
72
|
+
|
|
73
|
+
###### crudArgs.patch()
|
|
74
|
+
|
|
75
|
+
> **patch**: (`PartialDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
|
|
60
76
|
|
|
61
77
|
A function to be used instead of the default crud patch function.
|
|
62
78
|
|
|
63
|
-
######
|
|
79
|
+
###### Parameters
|
|
80
|
+
|
|
81
|
+
• **PartialDetailArgs**: `any`
|
|
82
|
+
|
|
83
|
+
###### Returns
|
|
84
|
+
|
|
85
|
+
[`ResponseData`](../config/objectCrud.md#responsedata)
|
|
86
|
+
|
|
87
|
+
###### crudArgs.retrieve()
|
|
64
88
|
|
|
65
|
-
> **retrieve**: `
|
|
89
|
+
> **retrieve**: (`RetrieveDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
|
|
66
90
|
|
|
67
91
|
A function to be used instead of the default crud retrieve function.
|
|
68
92
|
|
|
69
|
-
######
|
|
93
|
+
###### Parameters
|
|
70
94
|
|
|
71
|
-
|
|
95
|
+
• **RetrieveDetailArgs**: `any`
|
|
96
|
+
|
|
97
|
+
###### Returns
|
|
98
|
+
|
|
99
|
+
[`ResponseData`](../config/objectCrud.md#responsedata)
|
|
100
|
+
|
|
101
|
+
###### crudArgs.subscribe()
|
|
102
|
+
|
|
103
|
+
> **subscribe**: (`SubscribeArgs`) => `void`
|
|
72
104
|
|
|
73
105
|
A function to be used instead of the default crud subscribe function.
|
|
74
106
|
|
|
75
|
-
######
|
|
107
|
+
###### Parameters
|
|
108
|
+
|
|
109
|
+
• **SubscribeArgs**: `any`
|
|
110
|
+
|
|
111
|
+
###### Returns
|
|
76
112
|
|
|
77
|
-
|
|
113
|
+
`void`
|
|
114
|
+
|
|
115
|
+
###### crudArgs.update()
|
|
116
|
+
|
|
117
|
+
> **update**: (`UpdateDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
|
|
78
118
|
|
|
79
119
|
A function to be used instead of the default crud update function.
|
|
80
120
|
|
|
121
|
+
###### Parameters
|
|
122
|
+
|
|
123
|
+
• **UpdateDetailArgs**: `any`
|
|
124
|
+
|
|
125
|
+
###### Returns
|
|
126
|
+
|
|
127
|
+
[`ResponseData`](../config/objectCrud.md#responsedata)
|
|
128
|
+
|
|
81
129
|
###### id
|
|
82
130
|
|
|
83
131
|
> **id**: `string`
|
|
@@ -172,42 +220,90 @@ The crud functions.
|
|
|
172
220
|
|
|
173
221
|
The arguments to be passed to the crud functions.
|
|
174
222
|
|
|
175
|
-
###### crud.create
|
|
223
|
+
###### crud.create()
|
|
176
224
|
|
|
177
|
-
> **create**: `
|
|
225
|
+
> **create**: (`CreateDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
|
|
178
226
|
|
|
179
227
|
A function to be used instead of the default crud create function.
|
|
180
228
|
|
|
181
|
-
######
|
|
229
|
+
###### Parameters
|
|
182
230
|
|
|
183
|
-
|
|
231
|
+
• **CreateDetailArgs**: `any`
|
|
232
|
+
|
|
233
|
+
###### Returns
|
|
234
|
+
|
|
235
|
+
[`ResponseData`](../config/objectCrud.md#responsedata)
|
|
236
|
+
|
|
237
|
+
###### crud.delete()
|
|
238
|
+
|
|
239
|
+
> **delete**: (`DeleteDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
|
|
184
240
|
|
|
185
241
|
A function to be used instead of the default crud delete function.
|
|
186
242
|
|
|
187
|
-
######
|
|
243
|
+
###### Parameters
|
|
244
|
+
|
|
245
|
+
• **DeleteDetailArgs**: `any`
|
|
246
|
+
|
|
247
|
+
###### Returns
|
|
188
248
|
|
|
189
|
-
|
|
249
|
+
[`ResponseData`](../config/objectCrud.md#responsedata)
|
|
250
|
+
|
|
251
|
+
###### crud.patch()
|
|
252
|
+
|
|
253
|
+
> **patch**: (`PartialDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
|
|
190
254
|
|
|
191
255
|
A function to be used instead of the default crud patch function.
|
|
192
256
|
|
|
193
|
-
######
|
|
257
|
+
###### Parameters
|
|
258
|
+
|
|
259
|
+
• **PartialDetailArgs**: `any`
|
|
260
|
+
|
|
261
|
+
###### Returns
|
|
262
|
+
|
|
263
|
+
[`ResponseData`](../config/objectCrud.md#responsedata)
|
|
264
|
+
|
|
265
|
+
###### crud.retrieve()
|
|
194
266
|
|
|
195
|
-
> **retrieve**: `
|
|
267
|
+
> **retrieve**: (`RetrieveDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
|
|
196
268
|
|
|
197
269
|
A function to be used instead of the default crud retrieve function.
|
|
198
270
|
|
|
199
|
-
######
|
|
271
|
+
###### Parameters
|
|
200
272
|
|
|
201
|
-
|
|
273
|
+
• **RetrieveDetailArgs**: `any`
|
|
274
|
+
|
|
275
|
+
###### Returns
|
|
276
|
+
|
|
277
|
+
[`ResponseData`](../config/objectCrud.md#responsedata)
|
|
278
|
+
|
|
279
|
+
###### crud.subscribe()
|
|
280
|
+
|
|
281
|
+
> **subscribe**: (`SubscribeArgs`) => `void`
|
|
202
282
|
|
|
203
283
|
A function to be used instead of the default crud subscribe function.
|
|
204
284
|
|
|
205
|
-
######
|
|
285
|
+
###### Parameters
|
|
286
|
+
|
|
287
|
+
• **SubscribeArgs**: `any`
|
|
288
|
+
|
|
289
|
+
###### Returns
|
|
206
290
|
|
|
207
|
-
|
|
291
|
+
`void`
|
|
292
|
+
|
|
293
|
+
###### crud.update()
|
|
294
|
+
|
|
295
|
+
> **update**: (`UpdateDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
|
|
208
296
|
|
|
209
297
|
A function to be used instead of the default crud update function.
|
|
210
298
|
|
|
299
|
+
###### Parameters
|
|
300
|
+
|
|
301
|
+
• **UpdateDetailArgs**: `any`
|
|
302
|
+
|
|
303
|
+
###### Returns
|
|
304
|
+
|
|
305
|
+
[`ResponseData`](../config/objectCrud.md#responsedata)
|
|
306
|
+
|
|
211
307
|
###### deleted
|
|
212
308
|
|
|
213
309
|
> **deleted**: `boolean`
|
|
@@ -36,42 +36,90 @@ The crud functions.
|
|
|
36
36
|
|
|
37
37
|
The arguments to be passed to the crud functions.
|
|
38
38
|
|
|
39
|
-
###### crud.create
|
|
39
|
+
###### crud.create()
|
|
40
40
|
|
|
41
|
-
> **create**: `
|
|
41
|
+
> **create**: (`CreateDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
|
|
42
42
|
|
|
43
43
|
A function to be used instead of the default crud create function.
|
|
44
44
|
|
|
45
|
-
######
|
|
45
|
+
###### Parameters
|
|
46
46
|
|
|
47
|
-
|
|
47
|
+
• **CreateDetailArgs**: `any`
|
|
48
|
+
|
|
49
|
+
###### Returns
|
|
50
|
+
|
|
51
|
+
[`ResponseData`](../config/objectCrud.md#responsedata)
|
|
52
|
+
|
|
53
|
+
###### crud.delete()
|
|
54
|
+
|
|
55
|
+
> **delete**: (`DeleteDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
|
|
48
56
|
|
|
49
57
|
A function to be used instead of the default crud delete function.
|
|
50
58
|
|
|
51
|
-
######
|
|
59
|
+
###### Parameters
|
|
60
|
+
|
|
61
|
+
• **DeleteDetailArgs**: `any`
|
|
62
|
+
|
|
63
|
+
###### Returns
|
|
52
64
|
|
|
53
|
-
|
|
65
|
+
[`ResponseData`](../config/objectCrud.md#responsedata)
|
|
66
|
+
|
|
67
|
+
###### crud.patch()
|
|
68
|
+
|
|
69
|
+
> **patch**: (`PartialDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
|
|
54
70
|
|
|
55
71
|
A function to be used instead of the default crud patch function.
|
|
56
72
|
|
|
57
|
-
######
|
|
73
|
+
###### Parameters
|
|
74
|
+
|
|
75
|
+
• **PartialDetailArgs**: `any`
|
|
76
|
+
|
|
77
|
+
###### Returns
|
|
78
|
+
|
|
79
|
+
[`ResponseData`](../config/objectCrud.md#responsedata)
|
|
80
|
+
|
|
81
|
+
###### crud.retrieve()
|
|
58
82
|
|
|
59
|
-
> **retrieve**: `
|
|
83
|
+
> **retrieve**: (`RetrieveDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
|
|
60
84
|
|
|
61
85
|
A function to be used instead of the default crud retrieve function.
|
|
62
86
|
|
|
63
|
-
######
|
|
87
|
+
###### Parameters
|
|
64
88
|
|
|
65
|
-
|
|
89
|
+
• **RetrieveDetailArgs**: `any`
|
|
90
|
+
|
|
91
|
+
###### Returns
|
|
92
|
+
|
|
93
|
+
[`ResponseData`](../config/objectCrud.md#responsedata)
|
|
94
|
+
|
|
95
|
+
###### crud.subscribe()
|
|
96
|
+
|
|
97
|
+
> **subscribe**: (`SubscribeArgs`) => `void`
|
|
66
98
|
|
|
67
99
|
A function to be used instead of the default crud subscribe function.
|
|
68
100
|
|
|
69
|
-
######
|
|
101
|
+
###### Parameters
|
|
102
|
+
|
|
103
|
+
• **SubscribeArgs**: `any`
|
|
104
|
+
|
|
105
|
+
###### Returns
|
|
70
106
|
|
|
71
|
-
|
|
107
|
+
`void`
|
|
108
|
+
|
|
109
|
+
###### crud.update()
|
|
110
|
+
|
|
111
|
+
> **update**: (`UpdateDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
|
|
72
112
|
|
|
73
113
|
A function to be used instead of the default crud update function.
|
|
74
114
|
|
|
115
|
+
###### Parameters
|
|
116
|
+
|
|
117
|
+
• **UpdateDetailArgs**: `any`
|
|
118
|
+
|
|
119
|
+
###### Returns
|
|
120
|
+
|
|
121
|
+
[`ResponseData`](../config/objectCrud.md#responsedata)
|
|
122
|
+
|
|
75
123
|
###### deleted
|
|
76
124
|
|
|
77
125
|
> **deleted**: `boolean`
|
|
@@ -236,42 +284,90 @@ The crud functions.
|
|
|
236
284
|
|
|
237
285
|
The arguments to be passed to the crud functions.
|
|
238
286
|
|
|
239
|
-
###### crud.create
|
|
287
|
+
###### crud.create()
|
|
240
288
|
|
|
241
|
-
> **create**: `
|
|
289
|
+
> **create**: (`CreateDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
|
|
242
290
|
|
|
243
291
|
A function to be used instead of the default crud create function.
|
|
244
292
|
|
|
245
|
-
######
|
|
293
|
+
###### Parameters
|
|
246
294
|
|
|
247
|
-
|
|
295
|
+
• **CreateDetailArgs**: `any`
|
|
296
|
+
|
|
297
|
+
###### Returns
|
|
298
|
+
|
|
299
|
+
[`ResponseData`](../config/objectCrud.md#responsedata)
|
|
300
|
+
|
|
301
|
+
###### crud.delete()
|
|
302
|
+
|
|
303
|
+
> **delete**: (`DeleteDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
|
|
248
304
|
|
|
249
305
|
A function to be used instead of the default crud delete function.
|
|
250
306
|
|
|
251
|
-
######
|
|
307
|
+
###### Parameters
|
|
308
|
+
|
|
309
|
+
• **DeleteDetailArgs**: `any`
|
|
310
|
+
|
|
311
|
+
###### Returns
|
|
252
312
|
|
|
253
|
-
|
|
313
|
+
[`ResponseData`](../config/objectCrud.md#responsedata)
|
|
314
|
+
|
|
315
|
+
###### crud.patch()
|
|
316
|
+
|
|
317
|
+
> **patch**: (`PartialDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
|
|
254
318
|
|
|
255
319
|
A function to be used instead of the default crud patch function.
|
|
256
320
|
|
|
257
|
-
######
|
|
321
|
+
###### Parameters
|
|
322
|
+
|
|
323
|
+
• **PartialDetailArgs**: `any`
|
|
324
|
+
|
|
325
|
+
###### Returns
|
|
326
|
+
|
|
327
|
+
[`ResponseData`](../config/objectCrud.md#responsedata)
|
|
328
|
+
|
|
329
|
+
###### crud.retrieve()
|
|
258
330
|
|
|
259
|
-
> **retrieve**: `
|
|
331
|
+
> **retrieve**: (`RetrieveDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
|
|
260
332
|
|
|
261
333
|
A function to be used instead of the default crud retrieve function.
|
|
262
334
|
|
|
263
|
-
######
|
|
335
|
+
###### Parameters
|
|
264
336
|
|
|
265
|
-
|
|
337
|
+
• **RetrieveDetailArgs**: `any`
|
|
338
|
+
|
|
339
|
+
###### Returns
|
|
340
|
+
|
|
341
|
+
[`ResponseData`](../config/objectCrud.md#responsedata)
|
|
342
|
+
|
|
343
|
+
###### crud.subscribe()
|
|
344
|
+
|
|
345
|
+
> **subscribe**: (`SubscribeArgs`) => `void`
|
|
266
346
|
|
|
267
347
|
A function to be used instead of the default crud subscribe function.
|
|
268
348
|
|
|
269
|
-
######
|
|
349
|
+
###### Parameters
|
|
350
|
+
|
|
351
|
+
• **SubscribeArgs**: `any`
|
|
352
|
+
|
|
353
|
+
###### Returns
|
|
270
354
|
|
|
271
|
-
|
|
355
|
+
`void`
|
|
356
|
+
|
|
357
|
+
###### crud.update()
|
|
358
|
+
|
|
359
|
+
> **update**: (`UpdateDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
|
|
272
360
|
|
|
273
361
|
A function to be used instead of the default crud update function.
|
|
274
362
|
|
|
363
|
+
###### Parameters
|
|
364
|
+
|
|
365
|
+
• **UpdateDetailArgs**: `any`
|
|
366
|
+
|
|
367
|
+
###### Returns
|
|
368
|
+
|
|
369
|
+
[`ResponseData`](../config/objectCrud.md#responsedata)
|
|
370
|
+
|
|
275
371
|
###### deleted
|
|
276
372
|
|
|
277
373
|
> **deleted**: `boolean`
|
|
@@ -135,42 +135,90 @@ The arguments to be passed to the crud functions.
|
|
|
135
135
|
|
|
136
136
|
The arguments to be passed to the crud functions.
|
|
137
137
|
|
|
138
|
-
###### crudArgs.create
|
|
138
|
+
###### crudArgs.create()
|
|
139
139
|
|
|
140
|
-
> **create**: `
|
|
140
|
+
> **create**: (`CreateDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
|
|
141
141
|
|
|
142
142
|
A function to be used instead of the default crud create function.
|
|
143
143
|
|
|
144
|
-
######
|
|
144
|
+
###### Parameters
|
|
145
145
|
|
|
146
|
-
|
|
146
|
+
• **CreateDetailArgs**: `any`
|
|
147
|
+
|
|
148
|
+
###### Returns
|
|
149
|
+
|
|
150
|
+
[`ResponseData`](../config/objectCrud.md#responsedata)
|
|
151
|
+
|
|
152
|
+
###### crudArgs.delete()
|
|
153
|
+
|
|
154
|
+
> **delete**: (`DeleteDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
|
|
147
155
|
|
|
148
156
|
A function to be used instead of the default crud delete function.
|
|
149
157
|
|
|
150
|
-
######
|
|
158
|
+
###### Parameters
|
|
151
159
|
|
|
152
|
-
|
|
160
|
+
• **DeleteDetailArgs**: `any`
|
|
161
|
+
|
|
162
|
+
###### Returns
|
|
163
|
+
|
|
164
|
+
[`ResponseData`](../config/objectCrud.md#responsedata)
|
|
165
|
+
|
|
166
|
+
###### crudArgs.patch()
|
|
167
|
+
|
|
168
|
+
> **patch**: (`PartialDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
|
|
153
169
|
|
|
154
170
|
A function to be used instead of the default crud patch function.
|
|
155
171
|
|
|
156
|
-
######
|
|
172
|
+
###### Parameters
|
|
173
|
+
|
|
174
|
+
• **PartialDetailArgs**: `any`
|
|
157
175
|
|
|
158
|
-
|
|
176
|
+
###### Returns
|
|
177
|
+
|
|
178
|
+
[`ResponseData`](../config/objectCrud.md#responsedata)
|
|
179
|
+
|
|
180
|
+
###### crudArgs.retrieve()
|
|
181
|
+
|
|
182
|
+
> **retrieve**: (`RetrieveDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
|
|
159
183
|
|
|
160
184
|
A function to be used instead of the default crud retrieve function.
|
|
161
185
|
|
|
162
|
-
######
|
|
186
|
+
###### Parameters
|
|
187
|
+
|
|
188
|
+
• **RetrieveDetailArgs**: `any`
|
|
189
|
+
|
|
190
|
+
###### Returns
|
|
191
|
+
|
|
192
|
+
[`ResponseData`](../config/objectCrud.md#responsedata)
|
|
193
|
+
|
|
194
|
+
###### crudArgs.subscribe()
|
|
163
195
|
|
|
164
|
-
> **subscribe**: `
|
|
196
|
+
> **subscribe**: (`SubscribeArgs`) => `void`
|
|
165
197
|
|
|
166
198
|
A function to be used instead of the default crud subscribe function.
|
|
167
199
|
|
|
168
|
-
######
|
|
200
|
+
###### Parameters
|
|
169
201
|
|
|
170
|
-
|
|
202
|
+
• **SubscribeArgs**: `any`
|
|
203
|
+
|
|
204
|
+
###### Returns
|
|
205
|
+
|
|
206
|
+
`void`
|
|
207
|
+
|
|
208
|
+
###### crudArgs.update()
|
|
209
|
+
|
|
210
|
+
> **update**: (`UpdateDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
|
|
171
211
|
|
|
172
212
|
A function to be used instead of the default crud update function.
|
|
173
213
|
|
|
214
|
+
###### Parameters
|
|
215
|
+
|
|
216
|
+
• **UpdateDetailArgs**: `any`
|
|
217
|
+
|
|
218
|
+
###### Returns
|
|
219
|
+
|
|
220
|
+
[`ResponseData`](../config/objectCrud.md#responsedata)
|
|
221
|
+
|
|
174
222
|
###### id
|
|
175
223
|
|
|
176
224
|
> **id**: `string`
|
|
@@ -207,42 +255,90 @@ The crud functions.
|
|
|
207
255
|
|
|
208
256
|
The arguments to be passed to the crud functions.
|
|
209
257
|
|
|
210
|
-
###### crud.create
|
|
258
|
+
###### crud.create()
|
|
211
259
|
|
|
212
|
-
> **create**: `
|
|
260
|
+
> **create**: (`CreateDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
|
|
213
261
|
|
|
214
262
|
A function to be used instead of the default crud create function.
|
|
215
263
|
|
|
216
|
-
######
|
|
264
|
+
###### Parameters
|
|
217
265
|
|
|
218
|
-
|
|
266
|
+
• **CreateDetailArgs**: `any`
|
|
267
|
+
|
|
268
|
+
###### Returns
|
|
269
|
+
|
|
270
|
+
[`ResponseData`](../config/objectCrud.md#responsedata)
|
|
271
|
+
|
|
272
|
+
###### crud.delete()
|
|
273
|
+
|
|
274
|
+
> **delete**: (`DeleteDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
|
|
219
275
|
|
|
220
276
|
A function to be used instead of the default crud delete function.
|
|
221
277
|
|
|
222
|
-
######
|
|
278
|
+
###### Parameters
|
|
223
279
|
|
|
224
|
-
|
|
280
|
+
• **DeleteDetailArgs**: `any`
|
|
281
|
+
|
|
282
|
+
###### Returns
|
|
283
|
+
|
|
284
|
+
[`ResponseData`](../config/objectCrud.md#responsedata)
|
|
285
|
+
|
|
286
|
+
###### crud.patch()
|
|
287
|
+
|
|
288
|
+
> **patch**: (`PartialDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
|
|
225
289
|
|
|
226
290
|
A function to be used instead of the default crud patch function.
|
|
227
291
|
|
|
228
|
-
######
|
|
292
|
+
###### Parameters
|
|
293
|
+
|
|
294
|
+
• **PartialDetailArgs**: `any`
|
|
229
295
|
|
|
230
|
-
|
|
296
|
+
###### Returns
|
|
297
|
+
|
|
298
|
+
[`ResponseData`](../config/objectCrud.md#responsedata)
|
|
299
|
+
|
|
300
|
+
###### crud.retrieve()
|
|
301
|
+
|
|
302
|
+
> **retrieve**: (`RetrieveDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
|
|
231
303
|
|
|
232
304
|
A function to be used instead of the default crud retrieve function.
|
|
233
305
|
|
|
234
|
-
######
|
|
306
|
+
###### Parameters
|
|
307
|
+
|
|
308
|
+
• **RetrieveDetailArgs**: `any`
|
|
309
|
+
|
|
310
|
+
###### Returns
|
|
311
|
+
|
|
312
|
+
[`ResponseData`](../config/objectCrud.md#responsedata)
|
|
313
|
+
|
|
314
|
+
###### crud.subscribe()
|
|
235
315
|
|
|
236
|
-
> **subscribe**: `
|
|
316
|
+
> **subscribe**: (`SubscribeArgs`) => `void`
|
|
237
317
|
|
|
238
318
|
A function to be used instead of the default crud subscribe function.
|
|
239
319
|
|
|
240
|
-
######
|
|
320
|
+
###### Parameters
|
|
241
321
|
|
|
242
|
-
|
|
322
|
+
• **SubscribeArgs**: `any`
|
|
323
|
+
|
|
324
|
+
###### Returns
|
|
325
|
+
|
|
326
|
+
`void`
|
|
327
|
+
|
|
328
|
+
###### crud.update()
|
|
329
|
+
|
|
330
|
+
> **update**: (`UpdateDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
|
|
243
331
|
|
|
244
332
|
A function to be used instead of the default crud update function.
|
|
245
333
|
|
|
334
|
+
###### Parameters
|
|
335
|
+
|
|
336
|
+
• **UpdateDetailArgs**: `any`
|
|
337
|
+
|
|
338
|
+
###### Returns
|
|
339
|
+
|
|
340
|
+
[`ResponseData`](../config/objectCrud.md#responsedata)
|
|
341
|
+
|
|
246
342
|
###### deleted
|
|
247
343
|
|
|
248
344
|
> **deleted**: `boolean`
|