@arrai-innovations/reactive-helpers 17.0.0 → 17.0.2

package/docs/use/listSort.md

@@ -38,7 +38,7 @@ The calculated objects.
 
 ###### Index Signature
 
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 
 ###### calculatedObjectsParentStateObjectsWatchRunning?
 
@@ -54,7 +54,7 @@ The rules for the calculated objects.
 
 ###### Index Signature
 
- \[`rule`: `string`\]: (`object`, `relatedObject`, `calculatedObjects`) => `any`
+\[`rule`: `string`\]: (`object`, `relatedObject`, `calculatedObjects`) => `any`
 
 ###### calculatedObjectsWatchRunning?
 
@@ -124,7 +124,7 @@ Maintains computed references to the foreign keys for each object pk and rule, c
 
 ###### Index Signature
 
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 
 ###### inResults?
 
@@ -164,7 +164,7 @@ Maps each object pk and rule to a tuple consisting of the related object and its
 
 ###### Index Signature
 
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 
 ###### objectIndexes?
 
@@ -216,7 +216,7 @@ Stores computed references to related objects, allowing for dynamic access based
 
 ###### Index Signature
 
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 
 ###### relatedObjectsParentStateObjectsWatchRunning?
 
@@ -232,7 +232,7 @@ Defines the rules for establishing relationships, such as foreign key links and
 
 ###### Index Signature
 
- \[`rule`: `string`\]: [`ListRelatedRule`](listRelated.md#listrelatedrule)
+\[`rule`: `string`\]: [`ListRelatedRule`](listRelated.md#listrelatedrule)
 
 ###### relatedObjectsWatchRunning?
 
@@ -345,7 +345,7 @@ The calculated objects.
 
 ###### Index Signature
 
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 
 ###### calculatedObjectsParentStateObjectsWatchRunning?
 
@@ -361,7 +361,7 @@ The rules for the calculated objects.
 
 ###### Index Signature
 
- \[`rule`: `string`\]: (`object`, `relatedObject`, `calculatedObjects`) => `any`
+\[`rule`: `string`\]: (`object`, `relatedObject`, `calculatedObjects`) => `any`
 
 ###### calculatedObjectsWatchRunning?
 
@@ -431,7 +431,7 @@ Maintains computed references to the foreign keys for each object pk and rule, c
 
 ###### Index Signature
 
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 
 ###### inResults?
 
@@ -471,7 +471,7 @@ Maps each object pk and rule to a tuple consisting of the related object and its
 
 ###### Index Signature
 
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 
 ###### objectIndexes?
 
@@ -523,7 +523,7 @@ Stores computed references to related objects, allowing for dynamic access based
 
 ###### Index Signature
 
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 
 ###### relatedObjectsParentStateObjectsWatchRunning?
 
@@ -539,7 +539,7 @@ Defines the rules for establishing relationships, such as foreign key links and
 
 ###### Index Signature
 
- \[`rule`: `string`\]: [`ListRelatedRule`](listRelated.md#listrelatedrule)
+\[`rule`: `string`\]: [`ListRelatedRule`](listRelated.md#listrelatedrule)
 
 ###### relatedObjectsWatchRunning?
 
@@ -634,7 +634,7 @@ The calculated objects.
 
 ###### Index Signature
 
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 
 ###### calculatedObjectsParentStateObjectsWatchRunning?
 
@@ -650,7 +650,7 @@ The rules for the calculated objects.
 
 ###### Index Signature
 
- \[`rule`: `string`\]: (`object`, `relatedObject`, `calculatedObjects`) => `any`
+\[`rule`: `string`\]: (`object`, `relatedObject`, `calculatedObjects`) => `any`
 
 ###### calculatedObjectsWatchRunning?
 
@@ -720,7 +720,7 @@ Maintains computed references to the foreign keys for each object pk and rule, c
 
 ###### Index Signature
 
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 
 ###### inResults?
 
@@ -760,7 +760,7 @@ Maps each object pk and rule to a tuple consisting of the related object and its
 
 ###### Index Signature
 
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 
 ###### objectIndexes?
 
@@ -830,7 +830,7 @@ Stores computed references to related objects, allowing for dynamic access based
 
 ###### Index Signature
 
- \[`pk`: `string`\]: `object`
+\[`pk`: `string`\]: `object`
 
 ###### relatedObjectsParentStateObjectsWatchRunning?
 
@@ -846,7 +846,7 @@ Defines the rules for establishing relationships, such as foreign key links and
 
 ###### Index Signature
 
- \[`rule`: `string`\]: [`ListRelatedRule`](listRelated.md#listrelatedrule)
+\[`rule`: `string`\]: [`ListRelatedRule`](listRelated.md#listrelatedrule)
 
 ###### relatedObjectsWatchRunning?
 
@@ -1081,7 +1081,7 @@ instance configurations.
 
 Configuration options to set as defaults for list sorting.
 
-###### options.sortThrottleWait
+###### sortThrottleWait
 
 `number`
 

package/docs/use/object.md

@@ -206,7 +206,7 @@ The calculated object.
 
 ###### Index Signature
 
- \[`ruleKey`: `string`\]: `ComputedRef`\<`any`\>
+\[`ruleKey`: `string`\]: `ComputedRef`
 
 ###### calculatedObjectRules
 
@@ -372,7 +372,7 @@ Whether the object is loading.
 
 ###### object
 
-> **object**: \{\} \| \{`[key: string]`: `any`; `pkKey`: `string`; \}
+> **object**: \{\} \| \{ `[key: string]`: `any`;  `pkKey`: `string`; \}
 
 The object.
 
@@ -402,7 +402,7 @@ The related objects, indexed by the key in the related object.
 
 ###### Index Signature
 
- \[`rule`: `string`\]: `ComputedRef`\<`any`\>
+\[`rule`: `string`\]: `ComputedRef`
 
 ###### relatedObjectRules
 

package/docs/use/objectCalculated.md

@@ -170,7 +170,7 @@ Whether the object is loading.
 
 ###### object
 
-> **object**: \{\} \| \{`[key: string]`: `any`; `pkKey`: `string`; \}
+> **object**: \{\} \| \{ `[key: string]`: `any`;  `pkKey`: `string`; \}
 
 The object.
 
@@ -200,7 +200,7 @@ The related objects, indexed by the key in the related object.
 
 ###### Index Signature
 
- \[`rule`: `string`\]: `ComputedRef`\<`any`\>
+\[`rule`: `string`\]: `ComputedRef`
 
 ###### relatedObjectRules?
 
@@ -270,7 +270,7 @@ The calculated object.
 
 ###### Index Signature
 
- \[`ruleKey`: `string`\]: `ComputedRef`\<`any`\>
+\[`ruleKey`: `string`\]: `ComputedRef`
 
 ###### calculatedObjectRules
 
@@ -436,7 +436,7 @@ Whether the object is loading.
 
 ###### object
 
-> **object**: \{\} \| \{`[key: string]`: `any`; `pkKey`: `string`; \}
+> **object**: \{\} \| \{ `[key: string]`: `any`;  `pkKey`: `string`; \}
 
 The object.
 
@@ -466,7 +466,7 @@ The related objects, indexed by the key in the related object.
 
 ###### Index Signature
 
- \[`rule`: `string`\]: `ComputedRef`\<`any`\>
+\[`rule`: `string`\]: `ComputedRef`
 
 ###### relatedObjectRules?
 
@@ -556,7 +556,7 @@ The calculated object.
 
 ###### Index Signature
 
- \[`ruleKey`: `string`\]: `ComputedRef`\<`any`\>
+\[`ruleKey`: `string`\]: `ComputedRef`
 
 ##### calculatedObjectRules
 
@@ -638,7 +638,7 @@ The object calculated options.
 
 #### Index Signature
 
- \[`ruleKey`: `string`\]: (`object`, `relatedObject`) => `any`
+\[`ruleKey`: `string`\]: (`object`, `relatedObject`) => `any`
 
 ***
 

package/docs/use/objectInstance.md

@@ -93,7 +93,7 @@ Called to turn the current object into a new object on the server.
 
 ###### args
 
-###### args.object
+###### object
 
 `any`
 
@@ -121,7 +121,7 @@ Called to patch the current object on the server.
 
 ###### args
 
-###### args.partialObject
+###### partialObject
 
 [`CrudObject`](objectInstance.md#crudobject)
 
@@ -149,7 +149,7 @@ Called to update the current object on the server.
 
 ###### args
 
-###### args.object
+###### object
 
 [`CrudObject`](objectInstance.md#crudobject)
 
@@ -447,7 +447,7 @@ Whether the object is loading.
 
 ###### object
 
-> **object**: \{\} \| \{`[key: string]`: `any`; `pkKey`: `string`; \}
+> **object**: \{\} \| \{ `[key: string]`: `any`;  `pkKey`: `string`; \}
 
 The object.
 
@@ -563,7 +563,7 @@ The arguments to be passed to the retrieve function.
 
 ### CrudObject
 
-> **CrudObject**\<\>: \{`[key: string]`: `any`; `pkKey`: `string`; \} \| \{\}
+> **CrudObject**\<\>: \{ `[key: string]`: `any`;  `pkKey`: `string`; \} \| \{\}
 
 #### Type Parameters
 

package/docs/use/objectRelated.md

@@ -170,7 +170,7 @@ Whether the object is loading.
 
 ###### object
 
-> **object**: \{\} \| \{`[key: string]`: `any`; `pkKey`: `string`; \}
+> **object**: \{\} \| \{ `[key: string]`: `any`;  `pkKey`: `string`; \}
 
 The object.
 
@@ -368,7 +368,7 @@ Whether the object is loading.
 
 ###### object
 
-> **object**: \{\} \| \{`[key: string]`: `any`; `pkKey`: `string`; \}
+> **object**: \{\} \| \{ `[key: string]`: `any`;  `pkKey`: `string`; \}
 
 The object.
 
@@ -398,7 +398,7 @@ The related objects, indexed by the key in the related object.
 
 ###### Index Signature
 
- \[`rule`: `string`\]: `ComputedRef`\<`any`\>
+\[`rule`: `string`\]: `ComputedRef`
 
 ###### relatedObjectRules
 
@@ -492,7 +492,7 @@ The related objects, indexed by the key in the related object.
 
 ###### Index Signature
 
- \[`rule`: `string`\]: `ComputedRef`\<`any`\>
+\[`rule`: `string`\]: `ComputedRef`
 
 ##### relatedObjectRules
 
@@ -590,7 +590,7 @@ The key in the managed object that corresponds to the key in the related object.
 
 #### Index Signature
 
- \[`rule`: `string`\]: [`ObjectRelatedRule`](objectRelated.md#objectrelatedrule)
+\[`rule`: `string`\]: [`ObjectRelatedRule`](objectRelated.md#objectrelatedrule)
 
 ***
 

package/docs/use/objectSubscription.md

@@ -98,7 +98,7 @@ Subscribes to updates from an object, managing subscription state and
 
 ###### \_\_namedParameters?
 
-###### __namedParameters.retrieve
+###### retrieve
 
 `boolean`
 
@@ -309,7 +309,7 @@ Whether the object is loading.
 
 ###### object
 
-> **object**: \{\} \| \{`[key: string]`: `any`; `pkKey`: `string`; \}
+> **object**: \{\} \| \{ `[key: string]`: `any`;  `pkKey`: `string`; \}
 
 The object.
 

package/docs/use/search.md

@@ -302,13 +302,13 @@ A reactive wrapper around FlexSearch.Index.
 
 Options.
 
-###### options.props
+###### props
 
 [`SearchProps`](search.md#searchprops)
 
 Props.
 
-###### options.throttle
+###### throttle
 
 `number` = `500`
 

package/docs/use/watchesRunning.md

@@ -65,13 +65,13 @@ A composable function for handling watches running. When all the trigger refs ar
 
 The options for the watches running.
 
-###### options.triggerRefs
+###### triggerRefs
 
 `WatchSource`\<`any`\>[]
 
 The trigger refs.
 
-###### options.watchSentinelRefs
+###### watchSentinelRefs
 
 `Ref`\<`boolean`, `boolean`\>[]
 

package/docs/utils/assignReactiveObject.md

@@ -107,10 +107,16 @@ Keys to exclude from the addition or update.
 
 ##### addedKeys?
 
+Precaulcated array of keys to add, if available. Otherwise, the
+keys will be calculated.
+
 `any`[] | `Set`\<`any`\>
 
 ##### sameKeys?
 
+Precaulcated array of keys to update, if available. Otherwise, the
+keys will be calculated.
+
 `any`[] | `Set`\<`any`\>
 
 ##### doNotSetUndefinedKeys?
@@ -194,6 +200,9 @@ Keys to exclude from the addition.
 
 ##### addedKeys?
 
+Precaulcated array of keys to add, if available. Otherwise, the
+keys will be calculated.
+
 `any`[] | `Set`\<`any`\>
 
 #### Returns
@@ -344,6 +353,8 @@ Keys to exclude from removal.
 
 ##### removedKeys?
 
+An array to store removed keys.
+
 `any`[] | `Set`\<`any`\>
 
 #### Returns
@@ -386,6 +397,9 @@ Keys to exclude from the update.
 
 ##### sameKeys?
 
+Precaulcated array of keys to update, if available. Otherwise, the
+keys will be calculated.
+
 `any`[] | `Set`\<`any`\>
 
 #### Returns

package/docs/utils/classes.md

@@ -103,6 +103,8 @@ We unref your refs, so probably want a computed around this. We filter out false
 
 ##### cls
 
+Handles the multiple ways of specifying CSS class related values.
+
 [`CombinedClassesArgument`](classes.md#combinedclassesargument) | [`CombinedClassesArgument`](classes.md#combinedclassesargument)[]
 
 #### Returns

package/docs/utils/flattenPaths.md

@@ -28,19 +28,19 @@ Array or object to flatten.
 
 Options.
 
-###### options.currentPath
+###### currentPath
 
 `string`
 
 Current path, for recursion or as a starting point.
 
-###### options.depth
+###### depth
 
 `number`
 
 Current depth, for recursion.
 
-###### options.limit
+###### limit
 
 `number`
 

package/docs/utils/keyDiff.md

@@ -43,29 +43,33 @@ are the same, what keys are removed, and what keys are added.
 
 ##### newKeys
 
+Keys to consider as new.
+
 `string`[] | `Set`\<`any`\>
 
 ##### oldKeys
 
+Keys to consider as old.
+
 `string`[] | `Set`\<`any`\>
 
 ##### options?
 
 Which differences are returned.
 
-###### options.addedKeys
+###### addedKeys
 
 `boolean` = `true`
 
 If true, return keys that are added.
 
-###### options.removedKeys
+###### removedKeys
 
 `boolean` = `true`
 
 If true, return keys that are removed.
 
-###### options.sameKeys
+###### sameKeys
 
 `boolean` = `true`
 

package/docs/utils/relatedCalculatedHelpers.md

@@ -22,7 +22,7 @@
 
 ### getObjectRelatedByKey()
 
-> **getObjectRelatedByKey**(`obj`, `relatedObj`, `key`): [`any`, `string`]
+> **getObjectRelatedByKey**(`obj`, `relatedObj`, `key`): \[`any`, `string`\]
 
 Get the object and key of a related item.
 
@@ -48,7 +48,7 @@ The key to get the related item from.
 
 #### Returns
 
-[`any`, `string`]
+\[`any`, `string`\]
 
 The object and key of the related item.
 
@@ -56,7 +56,7 @@ The object and key of the related item.
 
 ### getObjectRelatedCalculatedByKey()
 
-> **getObjectRelatedCalculatedByKey**(`obj`, `relatedObj`, `calculatedObj`, `key`): [`any`, `string`]
+> **getObjectRelatedCalculatedByKey**(`obj`, `relatedObj`, `calculatedObj`, `key`): \[`any`, `string`\]
 
 Get the object and key of a calculated item.
 
@@ -88,6 +88,6 @@ The key to get the calculated item from.
 
 #### Returns
 
-[`any`, `string`]
+\[`any`, `string`\]
 
 The object and key of the calculated item.

package/docs/utils/watches.md

@@ -27,31 +27,31 @@ Initializes the AwaitNot with specified options for reactive property watching a
 
 Configuration options for AwaitNot.
 
-###### options.couldAlreadyBeFalse
+###### couldAlreadyBeFalse
 
 `boolean` = `false`
 
 Indicates if the property could already be in the false state at initialization.
 
-###### options.obj
+###### obj
 
 `any`
 
 The object containing the property to watch.
 
-###### options.prop
+###### prop
 
 `string`
 
 The property name to watch within the object.
 
-###### options.ref
+###### ref
 
-`Ref`\<`any`, `any`\>
+`Ref`
 
 A Vue ref to directly watch if provided.
 
-###### options.timeout
+###### timeout
 
 `number` = `1000`
 
@@ -77,7 +77,7 @@ The timeout in milliseconds before the promise is rejected.
 
 ##### ref
 
-> **ref**: `Readonly`\<`Ref`\<`any`, `any`\>\>
+> **ref**: `Readonly`\<`Ref`\>
 
 ##### reject()
 
@@ -216,7 +216,7 @@ Creates an instance of AwaitTimeout with a specified timeout duration.
 
 The options for the AwaitTimeout.
 
-###### options.timeout
+###### timeout
 
 `number` = `1000`
 
@@ -380,6 +380,8 @@ Starts the watch.
 
 ###### watchSources
 
+The source(s) to watch.
+
 `WatchSource`\<`any`\> | `WatchSource`\<`any`\>[]
 
 ###### watchFunc
@@ -396,7 +398,7 @@ Optional arguments to pass to the watch function.
 
 ###### watchOptions?
 
-`WatchOptions`\<`boolean`\> = `{}`
+`WatchOptions` = `{}`
 
 Optional watch options.
 
@@ -428,31 +430,31 @@ Helper function to get the resulting promise from an AwaitNot instance.
 
 Configuration options for AwaitNot.
 
-###### options.couldAlreadyBeFalse
+###### couldAlreadyBeFalse
 
 `boolean` = `true`
 
 Indicates if the property could already be in the false state at initialization.
 
-###### options.obj
+###### obj
 
 `any`
 
 The object containing the property to watch.
 
-###### options.prop
+###### prop
 
 `string`
 
 The property name to watch within the object.
 
-###### options.ref
+###### ref
 
-`Ref`\<`any`, `any`\>
+`Ref`
 
 A Vue ref to directly watch if provided.
 
-###### options.timeout
+###### timeout
 
 `number` = `1000`
 

package/lint-staged.config.js

@@ -1,6 +1,6 @@
 export default {
     "**/*.{js,cjs,mjs,ts,jsx,tsx}": [
-        "npx --no-install eslint --fix",
+        "npx --no-install eslint --cache --fix",
         "npx --no-install prettier --write",
         "npm run docs",
     ],