@lemoncode/fonk-formik/typings/index.d.ts

Fonk library for use with react-formik

import { ValidationSchema } from '@lemoncode/fonk';

/**
 * Main function to create an instance of FormikValidation. We could use `validateField`, `validateRecord` and/or `validateForm` to fire validations.
 * `updateValidationSchema`: to update validation schema after create form validation instance.
 *
 * **Arguments**
 * - ValidationSchema
 *
 * **Returns**
 *  - FormikValidation instance.
 */
export function createFormikValidation(
  validationSchema: ValidationSchema
): FormikValidation;

interface FormikValidation {
  validateField: (fieldId: string, value: any, values?: any) => Promise<string>;

  validateRecord: (
    values: any
  ) => Promise<{ recordErrors: Record<string, string> }>;

  validateForm: (
    values: any
  ) => Promise<
    Record<string, string> | { recordErrors: Record<string, string> }
  >;

  updateValidationSchema(validationSchema: ValidationSchema): void;
}