fix(types): allow omitting input in executeOnMount when it's undefined

TheEdoRan · Aug 14, 2024 · b2c02f0 · b2c02f0
1 parent 6e23887
commit b2c02f0
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 9 deletions.
diff --git a/packages/next-safe-action/src/hooks-utils.ts b/packages/next-safe-action/src/hooks-utils.ts
@@ -63,7 +63,7 @@ export const useExecuteOnMount = <S extends Schema | undefined>(
 	React.useEffect(() => {
 		const t = setTimeout(() => {
 			if (args.executeOnMount && !mounted.current) {
-				args.executeFn(args.executeOnMount.input);
+				args.executeFn(args.executeOnMount.input as S extends Schema ? InferIn<S> : void);
 				mounted.current = true;
 			}
 		}, args.executeOnMount?.delayMs ?? 0);

diff --git a/packages/next-safe-action/src/hooks.types.ts b/packages/next-safe-action/src/hooks.types.ts
@@ -6,10 +6,11 @@ import type { MaybePromise, Prettify } from "./utils.types";
  * Type of base utils object passed to `useAction`, `useOptimisticAction` and `useStateAction` hooks.
  */
 export type HookBaseUtils<S extends Schema | undefined> = {
-	executeOnMount?: {
-		input: S extends Schema ? InferIn<S> : undefined;
-		delayMs?: number;
-	};
+	executeOnMount?: (undefined extends S
+		? { input?: undefined }
+		: {
+				input: S extends Schema ? InferIn<S> : undefined;
+			}) & { delayMs?: number };
 };
 
 /**

diff --git a/website/docs/types.md b/website/docs/types.md
@@ -316,10 +316,11 @@ Type of base utils object passed to `useAction`, `useOptimisticAction` and `useS
 
 ```typescript
 export type HookBaseUtils<S extends Schema | undefined> = {
-  executeOnMount?: {
-    input: S extends Schema ? InferIn<S> : undefined;
-    delayMs?: number;
-  };
+  executeOnMount?: (undefined extends S
+    ? { input?: undefined }
+    : {
+        input: S extends Schema ? InferIn<S> : undefined;
+      }) & { delayMs?: number };
 };
 ```