added ValidateFunction Type

morrys · Nov 14, 2023 · 5257a66 · 5257a66
1 parent 6763d03
commit 5257a66
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 6 deletions.
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "relay-forms",
-  "version": "2.1.0",
+  "version": "2.1.1",
   "keywords": [
     "forms",
     "relay",

diff --git a/src/RelayFormsTypes.ts b/src/RelayFormsTypes.ts
@@ -10,10 +10,15 @@ export type FormSubmitReturn = {
     reset: () => void;
 };
 
+export type ValidateFunction<ValueType> = (
+    value: ValueType,
+    deps?: { [key: string]: FormValueStateReturn<any> },
+) => Promise<string | undefined> | string | undefined;
+
 export type FormSetValueOptions<ValueType> = {
     key: string;
     initialValue?: ValueType;
-    validate?: (value: ValueType) => Promise<string | undefined> | string | undefined;
+    validate?: ValidateFunction<ValueType>;
     validateOnChange?: boolean;
     label?: string;
     dependsOn?: ReadonlyArray<string> | null | undefined;

diff --git a/src/useFormField.tsx b/src/useFormField.tsx
@@ -10,6 +10,7 @@ import {
     FormSetValueOptions,
     FormSetValueReturn,
     FormSetValueStateReturn,
+    ValidateFunction,
 } from './RelayFormsTypes';
 import { getSnapshot, getFieldId, commit } from './Utils';
 
@@ -60,10 +61,7 @@ function logicSetValue<ValueType>(params: LogicParams<ValueType>): LogicReturn<V
         return deps;
     }
 
-    function getValidate(): (
-        value: ValueType,
-        deps?: ReadonlyArray<any>,
-    ) => Promise<string | undefined> | string | undefined {
+    function getValidate(): ValidateFunction<ValueType> {
         return validate;
     }
     const ref = {