Merge pull request #3871 from SophanySC/fix/ISSUE-3846-setValue-docs

fix-docs: return type of setValue in docs did not match the function typing
jaredpalmer · Sep 12, 2023 · ce305f5 · ce305f5
2 parents fe4ed7e + 405578c
commit ce305f5
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/docs/api/formik.md b/docs/api/formik.md
@@ -216,7 +216,7 @@ Set `touched` imperatively. Calling this will trigger validation to run if `vali
 
 If `validateOnBlur` is set to `true` and there are errors, they will be resolved in the returned `Promise`.
 
-#### `setValues: (fields: React.SetStateAction<{ [field: string]: any }>, shouldValidate?: boolean) => void`
+#### `setValues: (fields: React.SetStateAction<{ [field: string]: any }>, shouldValidate?: boolean) => Promise<void | FormikErrors<Values>>`
 
 Set `values` imperatively. Calling this will trigger validation to run if `validateOnChange` is set to `true` (which it is by default). You can also explicitly prevent/skip validation by passing a second argument as `false`.