formik-validation-adaptors
Version:
A lightweight utility to integrate Zod and Joi validation with Formik.
34 lines (33 loc) • 1.11 kB
TypeScript
import { Suite } from "vest";
/**
* A Formik-compatible validation function using Vest.
*
* @param {Suite<string, string, (data: any) => void>} suite - The Vest test suite used for validation.
* @returns A validation function for Formik, returning validation errors as an object.
*
* @example
* ```ts
* import vest, { test, create } from "vest";
* import formikVestValidator from "./formikVestValidator";
*
* // Define a Vest validation suite
* const suite = create((data) => {
* test("name", "Name is required", () => {
* enforce(data.name).isNotEmpty();
* });
*
* test("email", "Invalid email format", () => {
* enforce(data.email).matches(/^[\w-.]+@([\w-]+\.)+[\w-]{2,4}$/);
* });
* });
*
* // Use in Formik
* const formik = useFormik({
* initialValues: { name: "", email: "" },
* validate: formikVestValidator(suite),
* onSubmit: (values) => console.log(values),
* });
* ```
*/
declare const formikVestValidator: (suite: Suite<string, string, (data: any) => void>) => (values: any) => Promise<Record<string, string>>;
export default formikVestValidator;