@radicalbit/formbit 2.0.0 → 2.1.0

package/README.md

@@ -9,51 +9,21 @@ Formbit is a **lightweight React state form library** designed to simplify form
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
 - [Features](#features)
-- [Abstract](#abstract)
 - [Install](#install)
-- [Getting started](#getting-started)
+- [Getting Started](#getting-started)
+- [Usage Patterns](#usage-patterns)
+  - [Context Provider](#context-provider)
+  - [Edit / Initialize Pattern](#edit--initialize-pattern)
+  - [Multi-Step Form](#multi-step-form)
 - [Local Development](#local-development)
-- [Type Aliases](#type-aliases)
-  - [Check](#check)
-  - [CheckFnOptions](#checkfnoptions)
-  - [ClearIsDirty](#clearisdirty)
-  - [ErrorCallback](#errorcallback)
-  - [ErrorCheckCallback](#errorcheckcallback)
-  - [ErrorFn](#errorfn)
-  - [Errors](#errors)
-  - [Form](#form)
+- [API Reference](#api-reference)
   - [FormbitObject](#formbitobject)
-  - [GenericCallback](#genericcallback)
-  - [InitialValues](#initialvalues)
-  - [Initialize](#initialize)
-  - [IsDirty](#isdirty)
-  - [IsFormInvalid](#isforminvalid)
-  - [IsFormValid](#isformvalid)
-  - [LiveValidation](#livevalidation)
-  - [LiveValidationFn](#livevalidationfn)
-  - [Object](#object)
-  - [Remove](#remove)
-  - [RemoveAll](#removeall)
-  - [ResetForm](#resetform)
-  - [SetError](#seterror)
-  - [SetSchema](#setschema)
-  - [SubmitForm](#submitform)
-  - [SuccessCallback](#successcallback)
-  - [SuccessCheckCallback](#successcheckcallback)
-  - [SuccessSubmitCallback](#successsubmitcallback)
-  - [Validate](#validate)
-  - [ValidateAll](#validateall)
-  - [ValidateFnOptions](#validatefnoptions)
-  - [ValidateForm](#validateform)
-  - [ValidateOptions](#validateoptions)
-  - [ValidationError](#validationerror)
-  - [ValidationFormbitError](#validationformbiterror)
-  - [ValidationSchema](#validationschema)
-  - [Write](#write)
-  - [WriteAll](#writeall)
-  - [WriteAllValue](#writeallvalue)
-  - [WriteFnOptions](#writefnoptions)
-  - [Writer](#writer)
+  - [Core Types](#core-types)
+  - [Callback Types](#callback-types)
+  - [Method Types](#method-types)
+  - [Options Types](#options-types)
+  - [Yup Re-Exports](#yup-re-exports)
+  - [Deprecated Types](#deprecated-types)
 - [License](#license)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
@@ -64,13 +34,10 @@ Formbit is a **lightweight React state form library** designed to simplify form
 
 - Intuitive and easy-to-use form state management.
 - Out of the box support for validation with [yup](https://github.com/jquense/yup).
-- Support for handling complex forms with dynamic and nested fields.
-- Seamless and flexible integration with React.
-- Full Typescript support.
-
-## Abstract
-
-The concept behind Formbit is to offer a lightweight library that assists you in managing all aspects of form state and error handling, while allowing you the flexibility to choose how to design the UI. It seamlessly integrates with various UI frameworks such as Antd, MaterialUI, or even plain HTML, as it provides solely a React hook that exposes methods to manage the form's React state. The responsibility of designing the UI remains entirely yours.
+- Full **TypeScript generics** — `useFormbit<FormData>(...)` infers paths, values, and callbacks.
+- Support for handling complex forms with dynamic and nested fields via **dot-path notation**.
+- **Context Provider** for sharing form state across deeply nested component trees.
+- Seamless and flexible integration with React — works with Antd, MaterialUI, or plain HTML.
 
 ## Install
 
@@ -82,65 +49,68 @@ npm  install  --save  formbit
 yarn  add  formbit
 ```
 
-## Getting started
+## Getting Started
+
+Three steps: **define a schema**, **call the hook**, **bind the UI**.
 
-```jsx
+```tsx
 import * as yup from 'yup';
-import useFormbit from 'formbit';
+import useFormbit from '@radicalbit/formbit';
 
-const initialValues = { name: undefined, age: undefined };
+// 1. Define a Yup schema and infer the TypeScript type from it
+const schema = yup.object({
+  name: yup.string().max(25, 'Max 25 characters').required('Name is required'),
+  age:  yup.number().max(120, 'Must be 0–120').required('Age is required'),
+});
 
-const schema = yup.object().shape({
-  name: yup
-    .string()
-    .max(25, 'Name max length is 25 characters')
-    .required('Name is required'),
+type FormData = yup.InferType<typeof schema>;
 
-  age: yup
-    .number()
-    .max(120, 'Age must be between 0 and 120')
-    .required('Age is required')
-});
+const initialValues: Partial<FormData> = { name: undefined, age: undefined };
 
+// 2. Call the hook with generics so every callback is fully typed
 function Example() {
-  const { form, submitForm, write, error, isFormInvalid } = useFormbit({
+  const { form, submitForm, write, error, isDirty } = useFormbit<FormData>({
     initialValues,
-    yup: schema
+    yup: schema,
   });
 
-  const handleChangeName = ({ target: { value } }) => { write('name', value); }
-  const handleChangeAge = ({ target: { value } }) => { write('age', value); }
+  const handleChangeName = ({ target: { value } }: React.ChangeEvent<HTMLInputElement>) => {
+    write('name', value);
+  };
+
+  const handleChangeAge = ({ target: { value } }: React.ChangeEvent<HTMLInputElement>) => {
+    write('age', Number(value));
+  };
+
   const handleSubmit = () => {
     submitForm(
-      (writer) => {
-        console.log("Your validated form is: ", writer.form)
-      }, 
-      (writer) => {
-        console.error("The validation errors are: ", writer.errors)
-      });
-    }
+      ({ form }) => console.log('Validated form:', form),
+      ({ errors }) => console.error('Validation errors:', errors),
+    );
+  };
 
+  // 3. Bind inputs, errors, and submit — Formbit stays out of your UI
   return (
     <div>
-      <label name="name">Name</label>
+      <label htmlFor="name">Name</label>
       <input
-        name="name"
-        onChange={handleChangeName}
+        id="name"
         type="text"
-        value={form.name}
+        value={form.name ?? ''}
+        onChange={handleChangeName}
       />
       <div>{error('name')}</div>
 
-      <label name="age">Age</label>
+      <label htmlFor="age">Age</label>
       <input
-        name="age"
-        onChange={handleChangeAge}
+        id="age"
         type="number"
-        value={form.age}
+        value={form.age ?? ''}
+        onChange={handleChangeAge}
       />
       <div>{error('age')}</div>
 
-      <button disabled={isFormInvalid()} onClick={handleSubmit} type="button">
+      <button disabled={!isDirty} onClick={handleSubmit} type="button">
         Submit
       </button>
     </div>
@@ -150,97 +120,233 @@ function Example() {
 export default Example;
 ```
 
-## Local Development
-For local development we suggest using [Yalc](https://github.com/wclr/yalc) to test your local version of formbit in your projects.
+## Usage Patterns
 
-<!-- START_TYPES_DOC -->
-## Type Aliases
+### Context Provider
 
-### Check
+Use `FormbitContextProvider` when you need to share form state across deeply nested components without prop drilling.
 
-Ƭ **Check**\<`Values`\>: (`json`: [`Form`](#form), `options?`: [`CheckFnOptions`](#checkfnoptions)\<`Values`\>) => [`ValidationError`](#validationerror)[] \| `undefined`
+```tsx
+import { FormbitContextProvider, useFormbitContext } from '@radicalbit/formbit';
+import * as yup from 'yup';
 
-Checks the given json against the form schema and returns and array of errors.
-It returns undefined if the json is valid.
+const schema = yup.object({
+  name:    yup.string().required('Name is required'),
+  surname: yup.string().required('Surname is required'),
+  age:     yup.number().required('Age is required'),
+});
 
-#### Type parameters
+type FormData = yup.InferType<typeof schema>;
 
-| Name | Type |
-| :------ | :------ |
-| `Values` | extends [`InitialValues`](#initialvalues) |
+const initialValues: Partial<FormData> = { name: undefined, surname: undefined, age: undefined };
 
-#### Type declaration
+// Wrap your form tree with the provider
+function App() {
+  return (
+    <FormbitContextProvider<FormData>
+      initialValues={initialValues}
+      yup={schema}
+    >
+      <NameField />
+      <SubmitButton />
+    </FormbitContextProvider>
+  );
+}
 
-▸ (`json`, `options?`): [`ValidationError`](#validationerror)[] \| `undefined`
+// Any child can access form state without props
+function NameField() {
+  const { form, write, error } = useFormbitContext<FormData>();
 
-##### Parameters
+  const handleChangeName = ({ target: { value } }: React.ChangeEvent<HTMLInputElement>) => {
+    write('name', value);
+  };
 
-| Name | Type |
-| :------ | :------ |
-| `json` | [`Form`](#form) |
-| `options?` | [`CheckFnOptions`](#checkfnoptions)\<`Values`\> |
+  return (
+    <div>
+      <input
+        value={form.name ?? ''}
+        onChange={handleChangeName}
+      />
+      <span>{error('name')}</span>
+    </div>
+  );
+}
 
-##### Returns
+function SubmitButton() {
+  const { submitForm, isDirty } = useFormbitContext<FormData>();
 
-[`ValidationError`](#validationerror)[] \| `undefined`
+  return (
+    <button
+      disabled={!isDirty}
+      onClick={() => submitForm(({ form }) => console.log(form))}
+    >
+      Submit
+    </button>
+  );
+}
+```
 
-#### Defined in
+### Edit / Initialize Pattern
 
-[index.ts:14](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L14)
+Start with empty initial values and call `initialize()` once data arrives from an API.
 
-___
+```tsx
+import { useEffect, useState } from 'react';
+import useFormbit from '@radicalbit/formbit';
+import * as yup from 'yup';
 
-### CheckFnOptions
+const schema = yup.object({
+  name:  yup.string().required(),
+  email: yup.string().email().required(),
+});
 
-Ƭ **CheckFnOptions**\<`Values`\>: `Object`
+type FormData = yup.InferType<typeof schema>;
 
-Options object to change the behavior of the check method
+const initialValues: Partial<FormData> = { name: undefined, email: undefined };
 
-#### Type parameters
+function EditUserForm({ userId }: { userId: string }) {
+  const { form, write, error, initialize, submitForm } = useFormbit<FormData>({
+    initialValues,
+    yup: schema,
+  });
 
-| Name | Type |
-| :------ | :------ |
-| `Values` | extends [`InitialValues`](#initialvalues) |
+  const [loading, setLoading] = useState(true);
 
-#### Type declaration
+  // Fetch and initialize — resetForm() will revert to these values
+  useEffect(() => {
+    fetch(`/api/users/${userId}`)
+      .then((res) => res.json())
+      .then((user) => { initialize(user); setLoading(false); });
+  }, [userId]);
 
-| Name | Type |
-| :------ | :------ |
-| `errorCallback?` | [`ErrorCheckCallback`](#errorcheckcallback)\<`Values`\> |
-| `options?` | [`ValidateOptions`](#validateoptions) |
-| `successCallback?` | [`SuccessCheckCallback`](#successcheckcallback)\<`Values`\> |
+  const handleChangeName = ({ target: { value } }: React.ChangeEvent<HTMLInputElement>) => {
+    write('name', value);
+  };
 
-#### Defined in
+  const handleChangeEmail = ({ target: { value } }: React.ChangeEvent<HTMLInputElement>) => {
+    write('email', value);
+  };
 
-[index.ts:309](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L309)
+  const handleSubmit = (e: React.FormEvent) => {
+    e.preventDefault();
+    submitForm(({ form }) => console.log(form));
+  };
 
-___
+  if (loading) return <p>Loading...</p>;
 
-### ClearIsDirty
+  return (
+    <form onSubmit={handleSubmit}>
+      <input value={form.name ?? ''} onChange={handleChangeName} />
+      <div>{error('name')}</div>
 
-Ƭ **ClearIsDirty**: () => `void`
+      <input value={form.email ?? ''} onChange={handleChangeEmail} />
+      <div>{error('email')}</div>
 
-Reset isDirty value to false
+      <button type="submit">Save</button>
+    </form>
+  );
+}
+```
 
-#### Type declaration
+### Multi-Step Form
 
-▸ (): `void`
+Use `__metadata` to store step state and `validateAll` to gate navigation between steps.
 
-##### Returns
+```tsx
+import useFormbit from '@radicalbit/formbit';
+import * as yup from 'yup';
 
-`void`
+const schema = yup.object({
+  name:  yup.string().required('Name is required'),
+  age:   yup.number().required('Age is required'),
+  email: yup.string().email().required('Email is required'),
+});
 
-#### Defined in
+type FormData = yup.InferType<typeof schema>;
+
+const initialValues: Partial<FormData> & { __metadata: { step: number } } = {
+  name: undefined,
+  age: undefined,
+  email: undefined,
+  __metadata: { step: 0 },
+};
+
+function MultiStepForm() {
+  const { form, write, error, validateAll, submitForm } = useFormbit<FormData>({
+    initialValues,
+    yup: schema,
+  });
+
+  const step = (form.__metadata?.step as number) ?? 0;
+  const goTo = (n: number) => write('__metadata.step', n);
+
+  // Validate only the current step's fields before advancing
+  const next = (paths: string[]) => {
+    validateAll(paths, {
+      successCallback: () => goTo(step + 1),
+    });
+  };
+
+  const handleChangeName = ({ target: { value } }: React.ChangeEvent<HTMLInputElement>) => {
+    write('name', value);
+  };
+
+  const handleChangeAge = ({ target: { value } }: React.ChangeEvent<HTMLInputElement>) => {
+    write('age', Number(value));
+  };
+
+  const handleChangeEmail = ({ target: { value } }: React.ChangeEvent<HTMLInputElement>) => {
+    write('email', value);
+  };
+
+  const handleSubmit = () => {
+    submitForm(({ form }) => console.log('Submit:', form));
+  };
+
+  return (
+    <div>
+      {step === 0 && (
+        <div>
+          <input value={form.name ?? ''} onChange={handleChangeName} />
+          <div>{error('name')}</div>
+          <button onClick={() => next(['name'])}>Next</button>
+        </div>
+      )}
+
+      {step === 1 && (
+        <div>
+          <input type="number" value={form.age ?? ''} onChange={handleChangeAge} />
+          <div>{error('age')}</div>
+          <button onClick={() => goTo(0)}>Back</button>
+          <button onClick={() => next(['age'])}>Next</button>
+        </div>
+      )}
+
+      {step === 2 && (
+        <div>
+          <input value={form.email ?? ''} onChange={handleChangeEmail} />
+          <div>{error('email')}</div>
+          <button onClick={() => goTo(1)}>Back</button>
+          <button onClick={handleSubmit}>Submit</button>
+        </div>
+      )}
+    </div>
+  );
+}
+```
 
-[index.ts:20](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L20)
+## Local Development
+For local development we suggest using [Yalc](https://github.com/wclr/yalc) to test your local version of formbit in your projects.
 
-___
+<!-- START_TYPES_DOC -->
+## API Reference
 
-### ErrorCallback
+### FormbitObject
 
-Ƭ **ErrorCallback**\<`Values`\>: (`writer`: [`Writer`](#writer)\<`Values`\>, `setError`: [`SetError`](#seterror)) => `void`
+Ƭ **FormbitObject**\<`Values`\>: `Object`
 
-Invoked in case of errors raised by validation
+Object returned by useFormbit() and useFormbitContextHook().
+It contains all the data and methods needed to handle the form.
 
 #### Type parameters
 
@@ -250,30 +356,73 @@ Invoked in case of errors raised by validation
 
 #### Type declaration
 
-▸ (`writer`, `setError`): `void`
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `check` | [`Check`](#check)\<`Partial`\<`Values`\>\> | Checks the given json against the form schema and returns an array of errors. It returns undefined if the json is valid. |
+| `error` | (`path`: `string`) => `string` \| `undefined` | - |
+| `errors` | [`Errors`](#errors) | Object including all the registered error messages since the last validation. Errors are stored using the same path of the corresponding form values. **`Example`** If the form object has this structure: ```json { "age": 1 } ``` and age is a non valid field, errors object will look like this ```json { "age": "Age must be greater then 18" } ``` |
+| `form` | `Partial`\<`Values`\> | Object containing the updated form. |
+| `initialize` | [`Initialize`](#initialize)\<`Values`\> | Initialize the form with new initial values. |
+| `isDirty` | `boolean` | Returns true if the form is Dirty (user already interacted with the form), false otherwise. |
+| `isFormInvalid` | () => `boolean` | - |
+| `isFormValid` | () => `boolean` | - |
+| `liveValidation` | (`path`: `string`) => ``true`` \| `undefined` | - |
+| `remove` | [`Remove`](#remove)\<`Values`\> | This method updates the form state deleting value, setting isDirty to true. After writing, it validates all the paths contained into pathsToValidate (if any) and all the fields that have the live validation active. |
+| `removeAll` | [`RemoveAll`](#removeall)\<`Values`\> | This method updates the form state deleting multiple values, setting isDirty to true. |
+| `resetForm` | () => `void` | - |
+| `setError` | [`SetError`](#seterror) | Set a message (value) to the given error path. |
+| `setSchema` | [`SetSchema`](#setschema)\<`Values`\> | Override the current schema with the given one. |
+| `submitForm` | [`SubmitForm`](#submitform)\<`Values`\> | Perform a validation against the current form object, and execute the successCallback if the validation passes, otherwise it executes the errorCallback. |
+| `validate` | [`Validate`](#validate)\<`Values`\> | This method only validates the specified path. Does not check for fields that have the live validation active. |
+| `validateAll` | [`ValidateAll`](#validateall)\<`Values`\> | This method only validates the specified paths. Does not check for fields that have the live validation active. |
+| `validateForm` | [`ValidateForm`](#validateform)\<`Partial`\<`Values`\>\> | This method validates the entire form and sets the corresponding errors if any. |
+| `write` | [`Write`](#write)\<`Values`\> | This method updates the form state writing $value into the $path, setting isDirty to true. After writing, it validates all the paths contained into $pathsToValidate (if any) and all the fields that have the live validation active. |
+| `writeAll` | [`WriteAll`](#writeall)\<`Values`\> | This method takes an array of [path, value] and updates the form state writing all those values into the specified paths. It sets isDirty to true. After writing, it validates all the paths contained into $pathToValidate and all the fields that have the live validation active. |
 
-##### Parameters
+#### Defined in
 
-| Name | Type |
-| :------ | :------ |
-| `writer` | [`Writer`](#writer)\<`Values`\> |
-| `setError` | [`SetError`](#seterror) |
+[index.ts:297](https://github.com/radicalbit/formbit/blob/1136d0a/src/types/index.ts#L297)
+### Core Types
 
-##### Returns
+#### Errors
 
-`void`
+Ƭ **Errors**: `Record`\<`string`, `string`\>
+
+Object including all the registered error messages since the last validation.
+Errors are stored using the same path of the corresponding form values.
+
+**`Example`**
+
+If the form object has this structure:
+```json
+{
+  "age": 1
+}
+```
+and age is a non valid field, errors object will look like this
+```json
+{
+  "age": "Age must be greater then 18"
+}
+```
 
 #### Defined in
 
-[index.ts:25](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L25)
+[index.ts:78](https://github.com/radicalbit/formbit/blob/1136d0a/src/types/index.ts#L78)
+#### Form
 
-___
+Ƭ **Form**: [`FormbitValues`](#formbitvalues)
 
-### ErrorCheckCallback
+Object containing the updated form.
+
+#### Defined in
 
-Ƭ **ErrorCheckCallback**\<`Values`\>: (`json`: [`Form`](#form), `inner`: [`ValidationError`](#validationerror)[], `writer`: [`Writer`](#writer)\<`Values`\>, `setError`: [`SetError`](#seterror)) => `void`
+[index.ts:55](https://github.com/radicalbit/formbit/blob/1136d0a/src/types/index.ts#L55)
+#### FormState
 
-Invoked in case of errors raised by validation of check method
+Ƭ **FormState**\<`Values`\>: `Object`
+
+Internal form state storing all the data of the form (except the validation schema).
 
 #### Type parameters
 
@@ -283,60 +432,46 @@ Invoked in case of errors raised by validation of check method
 
 #### Type declaration
 
-▸ (`json`, `inner`, `writer`, `setError`): `void`
-
-##### Parameters
-
 | Name | Type |
 | :------ | :------ |
-| `json` | [`Form`](#form) |
-| `inner` | [`ValidationError`](#validationerror)[] |
-| `writer` | [`Writer`](#writer)\<`Values`\> |
-| `setError` | [`SetError`](#seterror) |
-
-##### Returns
-
-`void`
+| `errors` | [`Errors`](#errors) |
+| `form` | `Values` |
+| `initialValues` | `Values` |
+| `isDirty` | `boolean` |
+| `liveValidation` | [`LiveValidation`](#livevalidation) |
 
 #### Defined in
 
-[index.ts:31](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L31)
-
-___
-
-### ErrorFn
+[index.ts:110](https://github.com/radicalbit/formbit/blob/1136d0a/src/types/index.ts#L110)
+#### FormbitValues
 
-Ƭ **ErrorFn**: (`path`: `string`) => `string` \| `undefined`
-
-Returns the error message for the given path if any.
-It doesn't trigger any validation
-
-#### Type declaration
+Ƭ **FormbitValues**: \{ `__metadata?`: `FormbitRecord`  } & `FormbitRecord`
 
-▸ (`path`): `string` \| `undefined`
+Base type for form values: a record of string keys with an optional `__metadata` field.
 
-##### Parameters
+#### Defined in
 
-| Name | Type |
-| :------ | :------ |
-| `path` | `string` |
+[index.ts:52](https://github.com/radicalbit/formbit/blob/1136d0a/src/types/index.ts#L52)
+#### InitialValues
 
-##### Returns
+Ƭ **InitialValues**: [`FormbitValues`](#formbitvalues)
 
-`string` \| `undefined`
+InitialValues used to set up formbit; also used to reset the form to its original version.
 
 #### Defined in
 
-[index.ts:39](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L39)
+[index.ts:58](https://github.com/radicalbit/formbit/blob/1136d0a/src/types/index.ts#L58)
+#### LiveValidation
 
-___
+Ƭ **LiveValidation**: `Record`\<`string`, ``true``\>
 
-### Errors
+Object including all the values that are being live validated.
+Usually fields that fail validation (using one of the methods that triggers validation)
+will automatically be set to live-validated.
 
-Ƭ **Errors**: `Record`\<`string`, `string`\>
+A value/path is live-validated when validated at every change of the form.
 
-Object including all the registered errors messages since the last validation.
-Errors are stored using the same path of the corresponding form values.
+By default no field is live-validated.
 
 **`Example`**
 
@@ -346,78 +481,55 @@ If the form object has this structure:
   "age": 1
 }
 ```
-and age is a non valid field, errors object will look like this
+and age is a field that is being live-validated, liveValidation object will look like this
 ```json
 {
-  "age": "Age must be greater then 18"
+  "age": true
 }
 ```
 
 #### Defined in
 
-[index.ts:60](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L60)
-
-___
-
-### Form
+[index.ts:103](https://github.com/radicalbit/formbit/blob/1136d0a/src/types/index.ts#L103)
+### Callback Types
 
-Ƭ **Form**: \{ `__metadata?`: [`Object`](#object)  } & [`Object`](#object)
+#### CheckErrorCallback
 
-Object containing the updated form
+Ƭ **CheckErrorCallback**\<`Values`\>: (`json`: [`Form`](#form), `inner`: [`ValidationError`](#validationerror)[], `writer`: [`FormState`](#formstate)\<`Values`\>, `setError`: [`SetError`](#seterror)) => `void`
 
-#### Defined in
-
-[index.ts:65](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L65)
+Invoked in case of errors raised by validation of check method.
 
-___
+#### Type parameters
 
-### FormbitObject
+| Name | Type |
+| :------ | :------ |
+| `Values` | extends [`InitialValues`](#initialvalues) |
 
-Ƭ **FormbitObject**\<`Values`\>: `Object`
+#### Type declaration
 
-Object returned by useFormbit() and useFormbitContextHook()
-It contains all the data and methods needed to handle the form.
+▸ (`json`, `inner`, `writer`, `setError`): `void`
 
-#### Type parameters
+##### Parameters
 
 | Name | Type |
 | :------ | :------ |
-| `Values` | extends [`InitialValues`](#initialvalues) |
+| `json` | [`Form`](#form) |
+| `inner` | [`ValidationError`](#validationerror)[] |
+| `writer` | [`FormState`](#formstate)\<`Values`\> |
+| `setError` | [`SetError`](#seterror) |
 
-#### Type declaration
+##### Returns
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `check` | [`Check`](#check)\<`Partial`\<`Values`\>\> | Checks the given json against the form schema and returns and array of errors. It returns undefined if the json is valid. |
-| `error` | [`ErrorFn`](#errorfn) | Returns the error message for the given path if any. It doesn't trigger any validation |
-| `errors` | [`Errors`](#errors) | Object including all the registered errors messages since the last validation. Errors are stored using the same path of the corresponding form values. **`Example`** If the form object has this structure: ```json { "age": 1 } ``` and age is a non valid field, errors object will look like this ```json { "age": "Age must be greater then 18" } ``` |
-| `form` | `Partial`\<`Values`\> | Object containing the updated form |
-| `initialize` | [`Initialize`](#initialize)\<`Values`\> | Initialize the form with new initial values |
-| `isDirty` | `boolean` | Returns true if the form is Dirty (user already interacted with the form), false otherwise. |
-| `isFormInvalid` | [`IsFormInvalid`](#isforminvalid) | Returns true if the form is NOT valid It doesn't perform any validation, it checks if any errors are present |
-| `isFormValid` | [`IsFormValid`](#isformvalid) | Returns true id the form is valid It doesn't perform any validation, it checks if any errors are present |
-| `liveValidation` | [`LiveValidationFn`](#livevalidationfn) | Returns true if live validation is active for the given path |
-| `remove` | [`Remove`](#remove)\<`Values`\> | This method updates the form state deleting value, setting isDirty to true. After writing, it validates all the paths contained into pathsToValidate (if any) and all the fields that have the live validation active. |
-| `removeAll` | [`RemoveAll`](#removeall)\<`Values`\> | This method updates the form state deleting multiple values, setting isDirty to true. |
-| `resetForm` | [`ResetForm`](#resetform) | Reset form to the initial state. Errors and liveValidation are set back to empty objects. isDirty is set back to false |
-| `setError` | [`SetError`](#seterror) | Set a message(value) to the given error path. |
-| `setSchema` | [`SetSchema`](#setschema)\<`Values`\> | Override the current schema with the given one. |
-| `submitForm` | [`SubmitForm`](#submitform)\<`Values`\> | Perform a validation against the current form object, and execute the successCallback if the validation pass otherwise it executes the errorCallback |
-| `validate` | [`Validate`](#validate)\<`Values`\> | This method only validate the specified path. Do not check for fields that have the live validation active. |
-| `validateAll` | [`ValidateAll`](#validateall)\<`Values`\> | This method only validate the specified paths. Do not check for fields that have the live validation active. |
-| `validateForm` | [`ValidateForm`](#validateform)\<`Partial`\<`Values`\>\> | This method validates the entire form and set the corresponding errors if any. |
-| `write` | [`Write`](#write)\<`Values`\> | This method update the form state writing $value into the $path, setting isDirty to true. After writing, it validates all the paths contained into $pathsToValidate (if any) and all the fields that have the live validation active. |
-| `writeAll` | [`WriteAll`](#writeall)\<`Values`\> | This method takes an array of [path, value] and update the form state writing all those values into the specified paths. It set isDirty to true. After writing, it validate all the paths contained into $pathToValidate and all the fields that have the live validation active. |
+`void`
 
 #### Defined in
 
-[index.ts:348](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L348)
-
-___
+[index.ts:171](https://github.com/radicalbit/formbit/blob/1136d0a/src/types/index.ts#L171)
+#### CheckSuccessCallback
 
-### GenericCallback
+Ƭ **CheckSuccessCallback**\<`Values`\>: (`json`: [`Form`](#form), `writer`: [`FormState`](#formstate)\<`Values`\>, `setError`: [`SetError`](#seterror)) => `void`
 
-Ƭ **GenericCallback**\<`Values`\>: [`SuccessCallback`](#successcallback)\<`Values`\> \| [`ErrorCallback`](#errorcallback)\<`Values`\>
+Success callback invoked by the check method when the operation is successful.
 
 #### Type parameters
 
@@ -425,29 +537,30 @@ ___
 | :------ | :------ |
 | `Values` | extends [`InitialValues`](#initialvalues) |
 
-#### Defined in
+#### Type declaration
 
-[index.ts:67](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L67)
+▸ (`json`, `writer`, `setError`): `void`
 
-___
+##### Parameters
 
-### InitialValues
+| Name | Type |
+| :------ | :------ |
+| `json` | [`Form`](#form) |
+| `writer` | [`FormState`](#formstate)\<`Values`\> |
+| `setError` | [`SetError`](#seterror) |
 
-Ƭ **InitialValues**: \{ `__metadata?`: [`Object`](#object)  } & [`Object`](#object)
+##### Returns
 
-InitialValues used to setup formbit, used also to reset the form to the original version.
+`void`
 
 #### Defined in
 
-[index.ts:77](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L77)
-
-___
+[index.ts:162](https://github.com/radicalbit/formbit/blob/1136d0a/src/types/index.ts#L162)
+#### ErrorCallback
 
-### Initialize
-
-Ƭ **Initialize**\<`Values`\>: (`values`: `Partial`\<`Values`\>) => `void`
+Ƭ **ErrorCallback**\<`Values`\>: (`writer`: [`FormState`](#formstate)\<`Values`\>, `setError`: [`SetError`](#seterror)) => `void`
 
-Initialize the form with new initial values
+Invoked in case of errors raised by validation.
 
 #### Type parameters
 
@@ -457,13 +570,14 @@ Initialize the form with new initial values
 
 #### Type declaration
 
-▸ (`values`): `void`
+▸ (`writer`, `setError`): `void`
 
 ##### Parameters
 
 | Name | Type |
 | :------ | :------ |
-| `values` | `Partial`\<`Values`\> |
+| `writer` | [`FormState`](#formstate)\<`Values`\> |
+| `setError` | [`SetError`](#seterror) |
 
 ##### Returns
 
@@ -471,143 +585,135 @@ Initialize the form with new initial values
 
 #### Defined in
 
-[index.ts:71](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L71)
+[index.ts:157](https://github.com/radicalbit/formbit/blob/1136d0a/src/types/index.ts#L157)
+#### SubmitSuccessCallback
 
-___
+Ƭ **SubmitSuccessCallback**\<`Values`\>: (`writer`: [`FormState`](#formstate)\<`Values` \| `Omit`\<`Values`, ``"__metadata"``\>\>, `setError`: [`SetError`](#seterror), `clearIsDirty`: () => `void`) => `void`
 
-### IsDirty
-
-Ƭ **IsDirty**: `boolean`
-
-Returns true if the form is Dirty (user already interacted with the form), false otherwise.
-
-#### Defined in
-
-[index.ts:83](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L83)
+Success callback invoked by the submit method when the validation is successful.
+Is the right place to send your data to the backend.
 
-___
+#### Type parameters
 
-### IsFormInvalid
+| Name | Type |
+| :------ | :------ |
+| `Values` | extends [`InitialValues`](#initialvalues) |
 
-Ƭ **IsFormInvalid**: () => `boolean`
+#### Type declaration
 
-Returns true if the form is NOT valid
-It doesn't perform any validation, it checks if any errors are present
+▸ (`writer`, `setError`, `clearIsDirty`): `void`
 
-#### Type declaration
+##### Parameters
 
-▸ (): `boolean`
+| Name | Type |
+| :------ | :------ |
+| `writer` | [`FormState`](#formstate)\<`Values` \| `Omit`\<`Values`, ``"__metadata"``\>\> |
+| `setError` | [`SetError`](#seterror) |
+| `clearIsDirty` | () => `void` |
 
 ##### Returns
 
-`boolean`
+`void`
 
 #### Defined in
 
-[index.ts:89](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L89)
+[index.ts:181](https://github.com/radicalbit/formbit/blob/1136d0a/src/types/index.ts#L181)
+#### SuccessCallback
 
-___
+Ƭ **SuccessCallback**\<`Values`\>: (`writer`: [`FormState`](#formstate)\<`Values`\>, `setError`: [`SetError`](#seterror)) => `void`
 
-### IsFormValid
+Success callback invoked by some formbit methods when the operation is successful.
 
-Ƭ **IsFormValid**: () => `boolean`
+#### Type parameters
 
-Returns true id the form is valid
-It doesn't perform any validation, it checks if any errors are present
+| Name | Type |
+| :------ | :------ |
+| `Values` | extends [`InitialValues`](#initialvalues) |
 
 #### Type declaration
 
-▸ (): `boolean`
-
-##### Returns
-
-`boolean`
-
-#### Defined in
-
-[index.ts:95](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L95)
-
-___
-
-### LiveValidation
-
-Ƭ **LiveValidation**: `Record`\<`string`, ``true``\>
-
-Object including all the values that are being live validated.
-Usually fields that fail validation (using one of the method that triggers validation)
-will automatically set to be live-validated.
+▸ (`writer`, `setError`): `void`
 
-A value/path is live-validated when validated at every change of the form.
+##### Parameters
 
-By default no field is live-validated
+| Name | Type |
+| :------ | :------ |
+| `writer` | [`FormState`](#formstate)\<`Values`\> |
+| `setError` | [`SetError`](#seterror) |
 
-**`Example`**
+##### Returns
 
-If the form object has this structure:
-```json
-{
-  "age": 1
-}
-```
-and age is a field that is being live-validated, liveValidation object will look like this
-```json
-{
-  "age": "Age must be greater then 18"
-}
-```
+`void`
 
 #### Defined in
 
-[index.ts:121](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L121)
+[index.ts:152](https://github.com/radicalbit/formbit/blob/1136d0a/src/types/index.ts#L152)
+### Method Types
+
+#### Check
 
-___
+Ƭ **Check**\<`Values`\>: (`json`: [`Form`](#form), `options?`: [`CheckFnOptions`](#checkfnoptions)\<`Values`\>) => [`ValidationError`](#validationerror)[] \| `undefined`
 
-### LiveValidationFn
+See [FormbitObject.check](#check).
 
-Ƭ **LiveValidationFn**: (`path`: `string`) => ``true`` \| `undefined`
+#### Type parameters
 
-Returns true if live validation is active for the given path
+| Name | Type |
+| :------ | :------ |
+| `Values` | extends [`InitialValues`](#initialvalues) |
 
 #### Type declaration
 
-▸ (`path`): ``true`` \| `undefined`
+▸ (`json`, `options?`): [`ValidationError`](#validationerror)[] \| `undefined`
 
 ##### Parameters
 
 | Name | Type |
 | :------ | :------ |
-| `path` | `string` |
+| `json` | [`Form`](#form) |
+| `options?` | [`CheckFnOptions`](#checkfnoptions)\<`Values`\> |
 
 ##### Returns
 
-``true`` \| `undefined`
+[`ValidationError`](#validationerror)[] \| `undefined`
 
 #### Defined in
 
-[index.ts:127](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L127)
+[index.ts:213](https://github.com/radicalbit/formbit/blob/1136d0a/src/types/index.ts#L213)
+#### Initialize
+
+Ƭ **Initialize**\<`Values`\>: (`values`: `Partial`\<`Values`\>) => `void`
 
-___
+See [FormbitObject.initialize](#initialize).
 
-### Object
+#### Type parameters
 
-Ƭ **Object**: `Record`\<`string`, `unknown`\>
+| Name | Type |
+| :------ | :------ |
+| `Values` | extends [`InitialValues`](#initialvalues) |
 
-Generic object with string as keys
+#### Type declaration
 
-#### Defined in
+▸ (`values`): `void`
 
-[index.ts:133](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L133)
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `values` | `Partial`\<`Values`\> |
 
-___
+##### Returns
 
-### Remove
+`void`
 
-Ƭ **Remove**\<`Values`\>: (`path`: `string`, `options?`: [`WriteFnOptions`](#writefnoptions)\<`Values`\>) => `void`
+#### Defined in
+
+[index.ts:217](https://github.com/radicalbit/formbit/blob/1136d0a/src/types/index.ts#L217)
+#### Remove
 
-This method updates the form state deleting value and set isDirty to true.
+Ƭ **Remove**\<`Values`\>: (`path`: `string`, `options?`: [`WriteFnOptions`](#writefnoptions)\<`Values`\>) => `void`
 
-After writing, it validates all the paths contained into pathsToValidate (if any)
-and all the fields that have the live validation active.
+See [FormbitObject.remove](#remove).
 
 #### Type parameters
 
@@ -632,15 +738,12 @@ and all the fields that have the live validation active.
 
 #### Defined in
 
-[index.ts:152](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L152)
-
-___
-
-### RemoveAll
+[index.ts:220](https://github.com/radicalbit/formbit/blob/1136d0a/src/types/index.ts#L220)
+#### RemoveAll
 
 Ƭ **RemoveAll**\<`Values`\>: (`arr`: `string`[], `options?`: [`WriteFnOptions`](#writefnoptions)\<`Values`\>) => `void`
 
-This method updates the form state deleting multiple values, setting isDirty to true.
+See [FormbitObject.removeAll](#removeall).
 
 #### Type parameters
 
@@ -665,37 +768,12 @@ This method updates the form state deleting multiple values, setting isDirty to
 
 #### Defined in
 
-[index.ts:278](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L278)
-
-___
-
-### ResetForm
-
-Ƭ **ResetForm**: () => `void`
-
-Reset form to the initial state.
-Errors and liveValidation are set back to empty objects.
-isDirty is set back to false
-
-#### Type declaration
-
-▸ (): `void`
-
-##### Returns
-
-`void`
-
-#### Defined in
-
-[index.ts:160](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L160)
-
-___
-
-### SetError
+[index.ts:255](https://github.com/radicalbit/formbit/blob/1136d0a/src/types/index.ts#L255)
+#### SetError
 
 Ƭ **SetError**: (`path`: `string`, `value`: `string`) => `void`
 
-Set a message(value) to the given error path.
+See [FormbitObject.setError](#seterror).
 
 #### Type declaration
 
@@ -714,15 +792,12 @@ Set a message(value) to the given error path.
 
 #### Defined in
 
-[index.ts:175](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L175)
-
-___
-
-### SetSchema
+[index.ts:223](https://github.com/radicalbit/formbit/blob/1136d0a/src/types/index.ts#L223)
+#### SetSchema
 
 Ƭ **SetSchema**\<`Values`\>: (`newSchema`: [`ValidationSchema`](#validationschema)\<`Values`\>) => `void`
 
-Override the current schema with the given one.
+See [FormbitObject.setSchema](#setschema).
 
 #### Type parameters
 
@@ -746,16 +821,12 @@ Override the current schema with the given one.
 
 #### Defined in
 
-[index.ts:181](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L181)
-
-___
+[index.ts:226](https://github.com/radicalbit/formbit/blob/1136d0a/src/types/index.ts#L226)
+#### SubmitForm
 
-### SubmitForm
+Ƭ **SubmitForm**\<`Values`\>: (`successCallback`: [`SubmitSuccessCallback`](#submitsuccesscallback)\<`Values`\>, `errorCallback?`: [`ErrorCallback`](#errorcallback)\<`Partial`\<`Values`\>\>, `options?`: [`ValidateOptions`](#validateoptions)) => `void`
 
-Ƭ **SubmitForm**\<`Values`\>: (`successCallback`: [`SuccessSubmitCallback`](#successsubmitcallback)\<`Values`\>, `errorCallback?`: [`ErrorCallback`](#errorcallback)\<`Partial`\<`Values`\>\>, `options?`: [`ValidateOptions`](#validateoptions)) => `void`
-
-Perform a validation against the current form object, and execute the successCallback if the validation pass
-otherwise it executes the errorCallback
+See [FormbitObject.submitForm](#submitform).
 
 #### Type parameters
 
@@ -771,7 +842,7 @@ otherwise it executes the errorCallback
 
 | Name | Type |
 | :------ | :------ |
-| `successCallback` | [`SuccessSubmitCallback`](#successsubmitcallback)\<`Values`\> |
+| `successCallback` | [`SubmitSuccessCallback`](#submitsuccesscallback)\<`Values`\> |
 | `errorCallback?` | [`ErrorCallback`](#errorcallback)\<`Partial`\<`Values`\>\> |
 | `options?` | [`ValidateOptions`](#validateoptions) |
 
@@ -781,15 +852,12 @@ otherwise it executes the errorCallback
 
 #### Defined in
 
-[index.ts:188](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L188)
-
-___
+[index.ts:229](https://github.com/radicalbit/formbit/blob/1136d0a/src/types/index.ts#L229)
+#### Validate
 
-### SuccessCallback
-
-Ƭ **SuccessCallback**\<`Values`\>: (`writer`: [`Writer`](#writer)\<`Values`\>, `setError`: [`SetError`](#seterror)) => `void`
+Ƭ **Validate**\<`Values`\>: (`path`: `string`, `options?`: [`ValidateFnOptions`](#validatefnoptions)\<`Values`\>) => `void`
 
-Success callback invoked by some formbit methods when the operation is successful.
+See [FormbitObject.validate](#validate).
 
 #### Type parameters
 
@@ -799,14 +867,14 @@ Success callback invoked by some formbit methods when the operation is successfu
 
 #### Type declaration
 
-▸ (`writer`, `setError`): `void`
+▸ (`path`, `options?`): `void`
 
 ##### Parameters
 
 | Name | Type |
 | :------ | :------ |
-| `writer` | [`Writer`](#writer)\<`Values`\> |
-| `setError` | [`SetError`](#seterror) |
+| `path` | `string` |
+| `options?` | [`ValidateFnOptions`](#validatefnoptions)\<`Values`\> |
 
 ##### Returns
 
@@ -814,15 +882,12 @@ Success callback invoked by some formbit methods when the operation is successfu
 
 #### Defined in
 
-[index.ts:197](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L197)
+[index.ts:235](https://github.com/radicalbit/formbit/blob/1136d0a/src/types/index.ts#L235)
+#### ValidateAll
 
-___
-
-### SuccessCheckCallback
-
-Ƭ **SuccessCheckCallback**\<`Values`\>: (`json`: [`Form`](#form), `writer`: [`Writer`](#writer)\<`Values`\>, `setError`: [`SetError`](#seterror)) => `void`
+Ƭ **ValidateAll**\<`Values`\>: (`paths`: `string`[], `options?`: [`ValidateFnOptions`](#validatefnoptions)\<`Values`\>) => `void`
 
-Success callback invoked by the check method when the operation is successful.
+See [FormbitObject.validateAll](#validateall).
 
 #### Type parameters
 
@@ -832,15 +897,14 @@ Success callback invoked by the check method when the operation is successful.
 
 #### Type declaration
 
-▸ (`json`, `writer`, `setError`): `void`
+▸ (`paths`, `options?`): `void`
 
 ##### Parameters
 
 | Name | Type |
 | :------ | :------ |
-| `json` | [`Form`](#form) |
-| `writer` | [`Writer`](#writer)\<`Values`\> |
-| `setError` | [`SetError`](#seterror) |
+| `paths` | `string`[] |
+| `options?` | [`ValidateFnOptions`](#validatefnoptions)\<`Values`\> |
 
 ##### Returns
 
@@ -848,16 +912,12 @@ Success callback invoked by the check method when the operation is successful.
 
 #### Defined in
 
-[index.ts:203](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L203)
-
-___
-
-### SuccessSubmitCallback
+[index.ts:238](https://github.com/radicalbit/formbit/blob/1136d0a/src/types/index.ts#L238)
+#### ValidateForm
 
-Ƭ **SuccessSubmitCallback**\<`Values`\>: (`writer`: [`Writer`](#writer)\<`Values` \| `Omit`\<`Values`, ``"__metadata"``\>\>, `setError`: [`SetError`](#seterror), `clearIsDirty`: [`ClearIsDirty`](#clearisdirty)) => `void`
+Ƭ **ValidateForm**\<`Values`\>: (`successCallback?`: [`SuccessCallback`](#successcallback)\<`Values`\>, `errorCallback?`: [`ErrorCallback`](#errorcallback)\<`Values`\>, `options?`: [`ValidateOptions`](#validateoptions)) => `void`
 
-Success callback invoked by the submit method when the validation is successful.
-Is the right place to send your data to the backend.
+See [FormbitObject.validateForm](#validateform).
 
 #### Type parameters
 
@@ -867,15 +927,15 @@ Is the right place to send your data to the backend.
 
 #### Type declaration
 
-▸ (`writer`, `setError`, `clearIsDirty`): `void`
+▸ (`successCallback?`, `errorCallback?`, `options?`): `void`
 
 ##### Parameters
 
 | Name | Type |
 | :------ | :------ |
-| `writer` | [`Writer`](#writer)\<`Values` \| `Omit`\<`Values`, ``"__metadata"``\>\> |
-| `setError` | [`SetError`](#seterror) |
-| `clearIsDirty` | [`ClearIsDirty`](#clearisdirty) |
+| `successCallback?` | [`SuccessCallback`](#successcallback)\<`Values`\> |
+| `errorCallback?` | [`ErrorCallback`](#errorcallback)\<`Values`\> |
+| `options?` | [`ValidateOptions`](#validateoptions) |
 
 ##### Returns
 
@@ -883,16 +943,12 @@ Is the right place to send your data to the backend.
 
 #### Defined in
 
-[index.ts:211](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L211)
-
-___
+[index.ts:241](https://github.com/radicalbit/formbit/blob/1136d0a/src/types/index.ts#L241)
+#### Write
 
-### Validate
-
-Ƭ **Validate**\<`Values`\>: (`path`: `string`, `options?`: [`ValidateFnOptions`](#validatefnoptions)\<`Values`\>) => `void`
+Ƭ **Write**\<`Values`\>: (`path`: keyof `Values` \| `string`, `value`: `unknown`, `options?`: [`WriteFnOptions`](#writefnoptions)\<`Values`\>) => `void`
 
-This method only validate the specified path. Do not check for fields that have the
-live validation active.
+See [FormbitObject.write](#write).
 
 #### Type parameters
 
@@ -902,14 +958,15 @@ live validation active.
 
 #### Type declaration
 
-▸ (`path`, `options?`): `void`
+▸ (`path`, `value`, `options?`): `void`
 
 ##### Parameters
 
 | Name | Type |
 | :------ | :------ |
-| `path` | `string` |
-| `options?` | [`ValidateFnOptions`](#validatefnoptions)\<`Values`\> |
+| `path` | keyof `Values` \| `string` |
+| `value` | `unknown` |
+| `options?` | [`WriteFnOptions`](#writefnoptions)\<`Values`\> |
 
 ##### Returns
 
@@ -917,16 +974,12 @@ live validation active.
 
 #### Defined in
 
-[index.ts:222](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L222)
+[index.ts:247](https://github.com/radicalbit/formbit/blob/1136d0a/src/types/index.ts#L247)
+#### WriteAll
 
-___
-
-### ValidateAll
-
-Ƭ **ValidateAll**\<`Values`\>: (`paths`: `string`[], `options?`: [`ValidateFnOptions`](#validatefnoptions)\<`Values`\>) => `void`
+Ƭ **WriteAll**\<`Values`\>: (`arr`: [`WriteAllValue`](#writeallvalue)\<`Values`\>[], `options?`: [`WriteFnOptions`](#writefnoptions)\<`Values`\>) => `void`
 
-This method only validate the specified paths. Do not check for fields that have the
-live validation active.
+See [FormbitObject.writeAll](#writeall).
 
 #### Type parameters
 
@@ -936,14 +989,14 @@ live validation active.
 
 #### Type declaration
 
-▸ (`paths`, `options?`): `void`
+▸ (`arr`, `options?`): `void`
 
 ##### Parameters
 
 | Name | Type |
 | :------ | :------ |
-| `paths` | `string`[] |
-| `options?` | [`ValidateFnOptions`](#validatefnoptions)\<`Values`\> |
+| `arr` | [`WriteAllValue`](#writeallvalue)\<`Values`\>[] |
+| `options?` | [`WriteFnOptions`](#writefnoptions)\<`Values`\> |
 
 ##### Returns
 
@@ -951,15 +1004,14 @@ live validation active.
 
 #### Defined in
 
-[index.ts:229](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L229)
+[index.ts:251](https://github.com/radicalbit/formbit/blob/1136d0a/src/types/index.ts#L251)
+### Options Types
 
-___
+#### CheckFnOptions
 
-### ValidateFnOptions
-
-Ƭ **ValidateFnOptions**\<`Values`\>: `Object`
+Ƭ **CheckFnOptions**\<`Values`\>: `Object`
 
-Options object to change the behavior of the validate methods
+Options object to change the behavior of the check method.
 
 #### Type parameters
 
@@ -971,21 +1023,18 @@ Options object to change the behavior of the validate methods
 
 | Name | Type |
 | :------ | :------ |
-| `errorCallback?` | [`ErrorCallback`](#errorcallback)\<`Partial`\<`Values`\>\> |
+| `errorCallback?` | [`CheckErrorCallback`](#checkerrorcallback)\<`Values`\> |
 | `options?` | [`ValidateOptions`](#validateoptions) |
-| `successCallback?` | [`SuccessCallback`](#successcallback)\<`Partial`\<`Values`\>\> |
+| `successCallback?` | [`CheckSuccessCallback`](#checksuccesscallback)\<`Values`\> |
 
 #### Defined in
 
-[index.ts:319](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L319)
-
-___
+[index.ts:268](https://github.com/radicalbit/formbit/blob/1136d0a/src/types/index.ts#L268)
+#### ValidateFnOptions
 
-### ValidateForm
-
-Ƭ **ValidateForm**\<`Values`\>: (`successCallback?`: [`SuccessCallback`](#successcallback)\<`Values`\>, `errorCallback?`: [`ErrorCallback`](#errorcallback)\<`Values`\>, `options?`: [`ValidateOptions`](#validateoptions)) => `void`
+Ƭ **ValidateFnOptions**\<`Values`\>: `Object`
 
-This method validates the entire form and set the corresponding errors if any.
+Options object to change the behavior of the validate methods.
 
 #### Type parameters
 
@@ -995,72 +1044,77 @@ This method validates the entire form and set the corresponding errors if any.
 
 #### Type declaration
 
-▸ (`successCallback?`, `errorCallback?`, `options?`): `void`
-
-##### Parameters
-
 | Name | Type |
 | :------ | :------ |
-| `successCallback?` | [`SuccessCallback`](#successcallback)\<`Values`\> |
-| `errorCallback?` | [`ErrorCallback`](#errorcallback)\<`Values`\> |
+| `errorCallback?` | [`ErrorCallback`](#errorcallback)\<`Partial`\<`Values`\>\> |
 | `options?` | [`ValidateOptions`](#validateoptions) |
+| `successCallback?` | [`SuccessCallback`](#successcallback)\<`Partial`\<`Values`\>\> |
 
-##### Returns
+#### Defined in
 
-`void`
+[index.ts:277](https://github.com/radicalbit/formbit/blob/1136d0a/src/types/index.ts#L277)
+#### WriteAllValue
 
-#### Defined in
+Ƭ **WriteAllValue**\<`Values`\>: [keyof `Values` \| `string`, `unknown`]
+
+Tuple of [key, value] pair.
+
+#### Type parameters
 
-[index.ts:235](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L235)
+| Name | Type |
+| :------ | :------ |
+| `Values` | extends [`InitialValues`](#initialvalues) |
 
-___
+#### Defined in
 
-### ValidateOptions
+[index.ts:261](https://github.com/radicalbit/formbit/blob/1136d0a/src/types/index.ts#L261)
+#### WriteFnOptions
 
-Ƭ **ValidateOptions**: `YupValidateOptions`
+Ƭ **WriteFnOptions**\<`Values`\>: \{ `noLiveValidation?`: `boolean` ; `pathsToValidate?`: `string`[]  } & [`ValidateFnOptions`](#validatefnoptions)\<`Values`\>
 
-Type imported from the yup library.
-It represents the object with all the options that can be passed to the internal yup validation method,
+Options object to change the behavior of the write methods.
 
-Link to the Yup documentation [https://github.com/jquense/yup](https://github.com/jquense/yup)
+#### Type parameters
 
-#### Defined in
+| Name | Type |
+| :------ | :------ |
+| `Values` | extends [`InitialValues`](#initialvalues) |
 
-[index.ts:249](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L249)
+#### Defined in
 
-___
+[index.ts:286](https://github.com/radicalbit/formbit/blob/1136d0a/src/types/index.ts#L286)
+### Yup Re-Exports
 
-### ValidationError
+#### ValidateOptions
 
-Ƭ **ValidationError**: `YupValidationError`
+Ƭ **ValidateOptions**: `YupValidateOptions`
 
 Type imported from the yup library.
-It represents the error object returned when a validation fails
+It represents the object with all the options that can be passed to the internal yup validation method.
 
 Link to the Yup documentation [https://github.com/jquense/yup](https://github.com/jquense/yup)
 
 #### Defined in
 
-[index.ts:332](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L332)
+[index.ts:137](https://github.com/radicalbit/formbit/blob/1136d0a/src/types/index.ts#L137)
+#### ValidationError
 
-___
+Ƭ **ValidationError**: `YupValidationError`
 
-### ValidationFormbitError
+Type imported from the yup library.
+It represents the error object returned when a validation fails.
 
-Ƭ **ValidationFormbitError**: `Pick`\<[`ValidationError`](#validationerror), ``"message"`` \| ``"path"``\>
+Link to the Yup documentation [https://github.com/jquense/yup](https://github.com/jquense/yup)
 
 #### Defined in
 
-[index.ts:240](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L240)
-
-___
-
-### ValidationSchema
+[index.ts:145](https://github.com/radicalbit/formbit/blob/1136d0a/src/types/index.ts#L145)
+#### ValidationSchema
 
 Ƭ **ValidationSchema**\<`Values`\>: `ObjectSchema`\<`Values`\>
 
 Type imported from the yup library.
-It represents any validation schema created with the yup.object() method
+It represents any validation schema created with the yup.object() method.
 
 Link to the Yup documentation [https://github.com/jquense/yup](https://github.com/jquense/yup)
 
@@ -1072,18 +1126,38 @@ Link to the Yup documentation [https://github.com/jquense/yup](https://github.co
 
 #### Defined in
 
-[index.ts:169](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L169)
+[index.ts:129](https://github.com/radicalbit/formbit/blob/1136d0a/src/types/index.ts#L129)
+### Deprecated Types
 
-___
+<details>
+<summary>Show deprecated types</summary>
 
-### Write
+#### ClearIsDirty
 
-Ƭ **Write**\<`Values`\>: (`path`: keyof `Values` \| `string`, `value`: `unknown`, `options?`: [`WriteFnOptions`](#writefnoptions)\<`Values`\>) => `void`
+Ƭ **ClearIsDirty**: () => `void`
+
+**`Deprecated`**
+
+Inlined into [FormbitObject](#formbitobject).
+
+#### Type declaration
+
+▸ (): `void`
+
+##### Returns
+
+`void`
+
+#### Defined in
+
+[index.ts:199](https://github.com/radicalbit/formbit/blob/1136d0a/src/types/index.ts#L199)
+#### ErrorCheckCallback
 
-This method update the form state writing $value into the $path, setting isDirty to true.
+Ƭ **ErrorCheckCallback**\<`Values`\>: [`CheckErrorCallback`](#checkerrorcallback)\<`Values`\>
 
-After writing, it validates all the paths contained into $pathsToValidate (if any)
-and all the fields that have the live validation active.
+**`Deprecated`**
+
+Use [CheckErrorCallback](#checkerrorcallback) instead.
 
 #### Type parameters
 
@@ -1091,108 +1165,145 @@ and all the fields that have the live validation active.
 | :------ | :------ |
 | `Values` | extends [`InitialValues`](#initialvalues) |
 
+#### Defined in
+
+[index.ts:175](https://github.com/radicalbit/formbit/blob/1136d0a/src/types/index.ts#L175)
+#### ErrorFn
+
+Ƭ **ErrorFn**: (`path`: `string`) => `string` \| `undefined`
+
+**`Deprecated`**
+
+Inlined into [FormbitObject](#formbitobject).
+
 #### Type declaration
 
-▸ (`path`, `value`, `options?`): `void`
+▸ (`path`): `string` \| `undefined`
 
 ##### Parameters
 
 | Name | Type |
 | :------ | :------ |
-| `path` | keyof `Values` \| `string` |
-| `value` | `unknown` |
-| `options?` | [`WriteFnOptions`](#writefnoptions)\<`Values`\> |
+| `path` | `string` |
 
 ##### Returns
 
-`void`
+`string` \| `undefined`
 
 #### Defined in
 
-[index.ts:258](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L258)
+[index.ts:190](https://github.com/radicalbit/formbit/blob/1136d0a/src/types/index.ts#L190)
+#### IsDirty
 
-___
+Ƭ **IsDirty**: `boolean`
 
-### WriteAll
+**`Deprecated`**
 
-Ƭ **WriteAll**\<`Values`\>: (`arr`: [`WriteAllValue`](#writeallvalue)\<`Values`\>[], `options?`: [`WriteFnOptions`](#writefnoptions)\<`Values`\>) => `void`
+Inlined into [FormbitObject](#formbitobject).
 
-This method takes an array of [path, value] and update the form state writing
-all those values into the specified paths.
+#### Defined in
 
-It set isDirty to true.
+[index.ts:208](https://github.com/radicalbit/formbit/blob/1136d0a/src/types/index.ts#L208)
+#### IsFormInvalid
 
-After writing, it validate all the paths contained into $pathToValidate and all
-the fields that have the live validation active.
+Ƭ **IsFormInvalid**: () => `boolean`
 
-#### Type parameters
+**`Deprecated`**
 
-| Name | Type |
-| :------ | :------ |
-| `Values` | extends [`InitialValues`](#initialvalues) |
+Inlined into [FormbitObject](#formbitobject).
 
 #### Type declaration
 
-▸ (`arr`, `options?`): `void`
+▸ (): `boolean`
 
-##### Parameters
+##### Returns
 
-| Name | Type |
-| :------ | :------ |
-| `arr` | [`WriteAllValue`](#writeallvalue)\<`Values`\>[] |
-| `options?` | [`WriteFnOptions`](#writefnoptions)\<`Values`\> |
+`boolean`
+
+#### Defined in
+
+[index.ts:196](https://github.com/radicalbit/formbit/blob/1136d0a/src/types/index.ts#L196)
+#### IsFormValid
+
+Ƭ **IsFormValid**: () => `boolean`
+
+**`Deprecated`**
+
+Inlined into [FormbitObject](#formbitobject).
+
+#### Type declaration
+
+▸ (): `boolean`
 
 ##### Returns
 
-`void`
+`boolean`
 
 #### Defined in
 
-[index.ts:271](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L271)
+[index.ts:193](https://github.com/radicalbit/formbit/blob/1136d0a/src/types/index.ts#L193)
+#### LiveValidationFn
 
-___
+Ƭ **LiveValidationFn**: (`path`: `string`) => ``true`` \| `undefined`
 
-### WriteAllValue
+**`Deprecated`**
 
-Ƭ **WriteAllValue**\<`Values`\>: [keyof `Values` \| `string`, `unknown`]
+Inlined into [FormbitObject](#formbitobject).
 
-Tuple of [key, value] pair.
+#### Type declaration
 
-#### Type parameters
+▸ (`path`): ``true`` \| `undefined`
+
+##### Parameters
 
 | Name | Type |
 | :------ | :------ |
-| `Values` | extends [`InitialValues`](#initialvalues) |
+| `path` | `string` |
+
+##### Returns
+
+``true`` \| `undefined`
 
 #### Defined in
 
-[index.ts:285](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L285)
+[index.ts:205](https://github.com/radicalbit/formbit/blob/1136d0a/src/types/index.ts#L205)
+#### Object
 
-___
+Ƭ **Object**: `FormbitRecord`
 
-### WriteFnOptions
+**`Deprecated`**
 
-Ƭ **WriteFnOptions**\<`Values`\>: \{ `noLiveValidation?`: `boolean` ; `pathsToValidate?`: `string`[]  } & [`ValidateFnOptions`](#validatefnoptions)\<`Values`\>
+Use FormbitRecord instead. Renamed to avoid shadowing the global `Object`.
 
-Options object to change the behavior of the write methods
+#### Defined in
 
-#### Type parameters
+[index.ts:19](https://github.com/radicalbit/formbit/blob/1136d0a/src/types/index.ts#L19)
+#### ResetForm
 
-| Name | Type |
-| :------ | :------ |
-| `Values` | extends [`InitialValues`](#initialvalues) |
+Ƭ **ResetForm**: () => `void`
 
-#### Defined in
+**`Deprecated`**
+
+Inlined into [FormbitObject](#formbitobject).
+
+#### Type declaration
+
+▸ (): `void`
+
+##### Returns
+
+`void`
 
-[index.ts:338](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L338)
+#### Defined in
 
-___
+[index.ts:202](https://github.com/radicalbit/formbit/blob/1136d0a/src/types/index.ts#L202)
+#### SuccessCheckCallback
 
-### Writer
+Ƭ **SuccessCheckCallback**\<`Values`\>: [`CheckSuccessCallback`](#checksuccesscallback)\<`Values`\>
 
-Ƭ **Writer**\<`Values`\>: `Object`
+**`Deprecated`**
 
-Internal form state storing all the data of the form (except the validation schema)
+Use [CheckSuccessCallback](#checksuccesscallback) instead.
 
 #### Type parameters
 
@@ -1200,20 +1311,27 @@ Internal form state storing all the data of the form (except the validation sche
 | :------ | :------ |
 | `Values` | extends [`InitialValues`](#initialvalues) |
 
-#### Type declaration
+#### Defined in
+
+[index.ts:166](https://github.com/radicalbit/formbit/blob/1136d0a/src/types/index.ts#L166)
+#### Writer
+
+Ƭ **Writer**\<`Values`\>: [`FormState`](#formstate)\<`Values`\>
+
+**`Deprecated`**
+
+Use [FormState](#formstate) instead.
+
+#### Type parameters
 
 | Name | Type |
 | :------ | :------ |
-| `errors` | [`Errors`](#errors) |
-| `form` | `Values` |
-| `initialValues` | `Values` |
-| `isDirty` | [`IsDirty`](#isdirty) |
-| `liveValidation` | [`LiveValidation`](#livevalidation) |
+| `Values` | extends [`InitialValues`](#initialvalues) |
 
 #### Defined in
 
-[index.ts:297](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L297)
-
+[index.ts:119](https://github.com/radicalbit/formbit/blob/1136d0a/src/types/index.ts#L119)
+</details>
 <!-- END_TYPES_DOC -->
 
 ## License