スキーマ関連 / parseWithYup

parseWithYup

指定された yup スキーマを使用してフォームデータを解析し、送信内容の概要を返すヘルパーです。

1const submission = parseWithYup(payload, options);

#パラメータ

payload

フォームの送信方法に応じて、 FormData オブジェクトまたは URLSearchParams オブジェクトのいずれかになります。

options

schema

Yup スキーマ、または Yup スキーマを返す関数のいずれかです。

async

validateSync の代わりに yup スキーマから validate メソッドを使用してフォームデータを解析したい場合は、 true に設定してください。

#

1import { parseWithYup } from '@conform-to/zod';
2import { useForm } from '@conform-to/react';
3import * as yup from 'zod';
4
5const schema = yup.object({
6  email: yup.string().email(),
7  password: yup.string(),
8});
9
10function Example() {
11  const [form, fields] = useForm({
12    onValidate({ formData }) {
13      return parseWithYup(formData, { schema });
14    },
15  });
16
17  // ...
18}