docs(hooks): update JSDoc comments with base utils

TheEdoRan · Jul 21, 2024 · 2d9eea5 · 2d9eea5
1 parent 9b6bb69
commit 2d9eea5
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/packages/next-safe-action/src/hooks.ts b/packages/next-safe-action/src/hooks.ts
@@ -16,7 +16,7 @@ import { isError } from "./utils";
 /**
  * Use the action from a Client Component via hook.
  * @param safeActionFn The action function
- * @param utils Optional callbacks
+ * @param utils Optional base utils and callbacks
  *
  * {@link https://next-safe-action.dev/docs/execution/hooks/useaction See docs for more information}
  */
@@ -131,7 +131,7 @@ export const useAction = <
 /**
  * Use the action from a Client Component via hook, with optimistic data update.
  * @param safeActionFn The action function
- * @param utils Required `currentData` and `updateFn` and optional callbacks
+ * @param utils Required `currentData` and `updateFn` and optional base utils and callbacks
  *
  * {@link https://next-safe-action.dev/docs/execution/hooks/useoptimisticaction See docs for more information}
  */

diff --git a/packages/next-safe-action/src/stateful-hooks.ts b/packages/next-safe-action/src/stateful-hooks.ts
@@ -10,7 +10,7 @@ import type { HookBaseUtils, HookCallbacks, HookSafeStateActionFn } from "./hook
 /**
  * Use the stateful action from a Client Component via hook. Used for actions defined with [`stateAction`](https://next-safe-action.dev/docs/safe-action-client/instance-methods#action--stateaction).
  * @param safeActionFn The action function
- * @param utils Optional `initResult`, `permalink` and callbacks
+ * @param utils Optional `initResult`, `permalink`, base utils and callbacks
  *
  * {@link https://next-safe-action.dev/docs/execution/hooks/usestateaction See docs for more information}
  */