@arrai-innovations/reactive-helpers 13.0.2 → 13.0.4

package/docs/use/combineClasses.md

@@ -6,6 +6,14 @@
 
 # use/combineClasses
 
+## Type Aliases
+
+### CSSClasses
+
+> **CSSClasses**\<\>: `string` \| `string`[] \| `object` \| `Ref`
+
+#### Type Parameters
+
 ## Functions
 
 ### useCombineClasses()
@@ -18,7 +26,7 @@ Normalize various ways of specifying CSS classes into an object for use in Vue.j
 
 #### Parameters
 
-• ...**classes**: (`string` \| `string`[] \| `object` \| `Ref`\<`string` \| `string`[]\>)[]
+• ...**classes**: [`CSSClasses`](combineClasses.md#cssclasses)[]
 
 A mixed array containing multiple ways of specifying CSS classes.
 

package/docs/use/listInstance.md

@@ -175,11 +175,26 @@ Updates an object in the list.
 
 Default implementation are used as set by `setListCrud`.
 
+###### bulkDelete
+
+> **bulkDelete**: [`BulkDeleteFn`](../config/listCrud.md#bulkdeletefn)
+
+Provide the implementation for the bulkDelete
+ function.
+
 ###### list
 
-> **list**: `Function`
+> **list**: [`ListFn`](../config/listCrud.md#listfn)
+
+Provide the implementation for the list
+ function.
+
+###### subscribe
+
+> **subscribe**: [`SubscribeFn`](../config/listCrud.md#subscribefn)
 
-Provide the implementation for the list function.
+Provide the implementation for the
+ subscribe function.
 
 ##### keepOldPages
 

package/docs/use/loadingError.md

@@ -6,16 +6,84 @@
 
 # use/loadingError
 
+## Interfaces
+
+### LoadingError
+
+#### Properties
+
+##### clearError()
+
+> **clearError**: () => `void`
+
+Clear the error state.
+
+###### Returns
+
+`void`
+
+##### clearLoading()
+
+> **clearLoading**: () => `void`
+
+Clear the loading state.
+
+###### Returns
+
+`void`
+
+##### error
+
+> **error**: `Readonly`\<`Ref`\<`Error`\>\>
+
+The error that occurred.
+
+##### errored
+
+> **errored**: `Readonly`\<`Ref`\<`boolean`\>\>
+
+Whether an error has occurred.
+
+##### loading
+
+> **loading**: `Readonly`\<`Ref`\<`boolean`\>\>
+
+Whether the component is loading.
+
+##### setError()
+
+> **setError**: (`error`) => `void`
+
+Set the error state.
+
+###### Parameters
+
+• **error**: `any`
+
+###### Returns
+
+`void`
+
+##### setLoading()
+
+> **setLoading**: () => `void`
+
+Set the loading state.
+
+###### Returns
+
+`void`
+
 ## Functions
 
 ### useLoadingError()
 
-> **useLoadingError**(): `any`
+> **useLoadingError**(): [`LoadingError`](loadingError.md#loadingerror)
 
 A composable function for managing loading and error states.
 
 #### Returns
 
-`any`
+[`LoadingError`](loadingError.md#loadingerror)
 
 - An object containing reactive fields and actions for loading and error states.

package/docs/use/object.md

@@ -42,42 +42,90 @@ The arguments to be passed to the crud functions.
 
 The arguments to be passed to the crud functions.
 
-###### crudArgs.create
+###### crudArgs.create()
 
-> **create**: `Function`
+> **create**: (`CreateDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud create function.
 
-###### crudArgs.delete
+###### Parameters
 
-> **delete**: `Function`
+• **CreateDetailArgs**: `any`
+
+###### Returns
+
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
+###### crudArgs.delete()
+
+> **delete**: (`DeleteDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud delete function.
 
-###### crudArgs.patch
+###### Parameters
+
+• **DeleteDetailArgs**: `any`
+
+###### Returns
 
-> **patch**: `Function`
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
+###### crudArgs.patch()
+
+> **patch**: (`PartialDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud patch function.
 
-###### crudArgs.retrieve
+###### Parameters
+
+• **PartialDetailArgs**: `any`
+
+###### Returns
+
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
+###### crudArgs.retrieve()
 
-> **retrieve**: `Function`
+> **retrieve**: (`RetrieveDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud retrieve function.
 
-###### crudArgs.subscribe
+###### Parameters
 
-> **subscribe**: `Function`
+• **RetrieveDetailArgs**: `any`
+
+###### Returns
+
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
+###### crudArgs.subscribe()
+
+> **subscribe**: (`SubscribeArgs`) => `void`
 
 A function to be used instead of the default crud subscribe function.
 
-###### crudArgs.update
+###### Parameters
+
+• **SubscribeArgs**: `any`
+
+###### Returns
 
-> **update**: `Function`
+`void`
+
+###### crudArgs.update()
+
+> **update**: (`UpdateDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud update function.
 
+###### Parameters
+
+• **UpdateDetailArgs**: `any`
+
+###### Returns
+
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
 ###### id
 
 > **id**: `string`
@@ -172,42 +220,90 @@ The crud functions.
 
 The arguments to be passed to the crud functions.
 
-###### crud.create
+###### crud.create()
 
-> **create**: `Function`
+> **create**: (`CreateDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud create function.
 
-###### crud.delete
+###### Parameters
 
-> **delete**: `Function`
+• **CreateDetailArgs**: `any`
+
+###### Returns
+
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
+###### crud.delete()
+
+> **delete**: (`DeleteDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud delete function.
 
-###### crud.patch
+###### Parameters
+
+• **DeleteDetailArgs**: `any`
+
+###### Returns
 
-> **patch**: `Function`
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
+###### crud.patch()
+
+> **patch**: (`PartialDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud patch function.
 
-###### crud.retrieve
+###### Parameters
+
+• **PartialDetailArgs**: `any`
+
+###### Returns
+
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
+###### crud.retrieve()
 
-> **retrieve**: `Function`
+> **retrieve**: (`RetrieveDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud retrieve function.
 
-###### crud.subscribe
+###### Parameters
 
-> **subscribe**: `Function`
+• **RetrieveDetailArgs**: `any`
+
+###### Returns
+
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
+###### crud.subscribe()
+
+> **subscribe**: (`SubscribeArgs`) => `void`
 
 A function to be used instead of the default crud subscribe function.
 
-###### crud.update
+###### Parameters
+
+• **SubscribeArgs**: `any`
+
+###### Returns
 
-> **update**: `Function`
+`void`
+
+###### crud.update()
+
+> **update**: (`UpdateDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud update function.
 
+###### Parameters
+
+• **UpdateDetailArgs**: `any`
+
+###### Returns
+
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
 ###### deleted
 
 > **deleted**: `boolean`

package/docs/use/objectCalculated.md

@@ -36,42 +36,90 @@ The crud functions.
 
 The arguments to be passed to the crud functions.
 
-###### crud.create
+###### crud.create()
 
-> **create**: `Function`
+> **create**: (`CreateDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud create function.
 
-###### crud.delete
+###### Parameters
 
-> **delete**: `Function`
+• **CreateDetailArgs**: `any`
+
+###### Returns
+
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
+###### crud.delete()
+
+> **delete**: (`DeleteDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud delete function.
 
-###### crud.patch
+###### Parameters
+
+• **DeleteDetailArgs**: `any`
+
+###### Returns
 
-> **patch**: `Function`
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
+###### crud.patch()
+
+> **patch**: (`PartialDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud patch function.
 
-###### crud.retrieve
+###### Parameters
+
+• **PartialDetailArgs**: `any`
+
+###### Returns
+
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
+###### crud.retrieve()
 
-> **retrieve**: `Function`
+> **retrieve**: (`RetrieveDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud retrieve function.
 
-###### crud.subscribe
+###### Parameters
 
-> **subscribe**: `Function`
+• **RetrieveDetailArgs**: `any`
+
+###### Returns
+
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
+###### crud.subscribe()
+
+> **subscribe**: (`SubscribeArgs`) => `void`
 
 A function to be used instead of the default crud subscribe function.
 
-###### crud.update
+###### Parameters
+
+• **SubscribeArgs**: `any`
+
+###### Returns
 
-> **update**: `Function`
+`void`
+
+###### crud.update()
+
+> **update**: (`UpdateDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud update function.
 
+###### Parameters
+
+• **UpdateDetailArgs**: `any`
+
+###### Returns
+
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
 ###### deleted
 
 > **deleted**: `boolean`
@@ -236,42 +284,90 @@ The crud functions.
 
 The arguments to be passed to the crud functions.
 
-###### crud.create
+###### crud.create()
 
-> **create**: `Function`
+> **create**: (`CreateDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud create function.
 
-###### crud.delete
+###### Parameters
 
-> **delete**: `Function`
+• **CreateDetailArgs**: `any`
+
+###### Returns
+
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
+###### crud.delete()
+
+> **delete**: (`DeleteDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud delete function.
 
-###### crud.patch
+###### Parameters
+
+• **DeleteDetailArgs**: `any`
+
+###### Returns
 
-> **patch**: `Function`
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
+###### crud.patch()
+
+> **patch**: (`PartialDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud patch function.
 
-###### crud.retrieve
+###### Parameters
+
+• **PartialDetailArgs**: `any`
+
+###### Returns
+
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
+###### crud.retrieve()
 
-> **retrieve**: `Function`
+> **retrieve**: (`RetrieveDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud retrieve function.
 
-###### crud.subscribe
+###### Parameters
 
-> **subscribe**: `Function`
+• **RetrieveDetailArgs**: `any`
+
+###### Returns
+
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
+###### crud.subscribe()
+
+> **subscribe**: (`SubscribeArgs`) => `void`
 
 A function to be used instead of the default crud subscribe function.
 
-###### crud.update
+###### Parameters
+
+• **SubscribeArgs**: `any`
+
+###### Returns
 
-> **update**: `Function`
+`void`
+
+###### crud.update()
+
+> **update**: (`UpdateDetailArgs`) => [`ResponseData`](../config/objectCrud.md#responsedata)
 
 A function to be used instead of the default crud update function.
 
+###### Parameters
+
+• **UpdateDetailArgs**: `any`
+
+###### Returns
+
+[`ResponseData`](../config/objectCrud.md#responsedata)
+
 ###### deleted
 
 > **deleted**: `boolean`