From 513c4d5beed10e62771fb41ab76346a40429a455 Mon Sep 17 00:00:00 2001 From: jorisre Date: Fri, 26 Feb 2021 18:18:34 +0100 Subject: [PATCH] docs: v2 doc --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 24f55395..1d5617f6 100644 --- a/README.md +++ b/README.md @@ -26,12 +26,13 @@ We are moving away from native support for Yup validation. We are now supporting ## API -`resolver(schema: object, config?: object)` +`resolver(schema: object, schemaOptions?: object, resolverOptions: { mode: 'async' | 'sync' })` -| | type | Required | Description | -| ------ | -------- | -------- | -------------------------------------- | -| schema | `object` | ✓ | validation schema | -| config | `object` | | validation schema configuration object | +| | type | Required | Description | +| --------------- | -------- | -------- | --------------------------------------------- | +| schema | `object` | ✓ | validation schema | +| schemaOptions | `object` | | validation library schema options | +| resolverOptions | `object` | | resolver options, `async` is the default mode | ## Quickstart