react-browser-form
Version:
<div align="center"> <a href="https://deniskabana.github.io/react-browser-form/introduction" title="React Browser Form - Form management in React made simple for browsers."> <img src="https://raw.githubusercontent.com/deniskabana/react-browser-form/
22 lines (21 loc) • 923 B
TypeScript
import { ValidationSchema } from "../types";
interface ValidatorOptions {
/**
* Whether a failed validation should throw error or return a meta object.
* @default true
*/
shouldThrow: boolean;
}
interface ValidatorReturns<Schema> {
errors: Partial<Record<keyof Schema, string>>;
hasErrors: boolean;
}
/**
* This function is a utility to easily test React Browser Form validation schema against any object.
* @param data Object that you want to test against your validation schema
* @param validationSchema The React Browser Form validation schema to use
*
* - [Validation docs](https://deniskabana.github.io/react-browser-form/documentation/validation-and-transformation)
*/
export declare function validateFormData<Schema>(data: Partial<Schema>, validationSchema: ValidationSchema<Schema>, { shouldThrow }?: ValidatorOptions): ValidatorReturns<Schema>;
export {};