Skip to content

V2: Update readme #136

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 28, 2021
Merged

V2: Update readme #136

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down