apply a comment

hachibeeDI · Feb 21, 2024 · efeb53c · efeb53c
1 parent bf17c91
commit efeb53c
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/index.ts b/src/index.ts
@@ -249,6 +249,10 @@ export type Controller<State extends StateRestriction> = {
 type FormHook<State extends StateRestriction, Schema extends ZodType<any, any, any>> = {
   controller: Controller<State>;
 
+  /**
+   * @param handler handling logic
+   * @returns created handler is always return Promise, because of the schema validation run it asynchronously.
+   */
   handleSubmit: <R>(
     handler: (
       e: BaseSyntheticEvent,