regle-schemas

Regle スキーマ

Regle では、@regle/rules の代わりにスキーマライブラリを使ってバリデーションを実行できます。@regle/schemas をインストールし、Zod、Valibot、ArkType のスキーマ（または Standard Schema に準拠した任意のバリデーター）とともに useRegleSchema を使用してください。

import { useRegleSchema } from '@regle/schemas';
import { z } from 'zod';

const { r$ } = useRegleSchema(
  { email: '' },
  z.object({ email: z.string().email() })
);

主な概念

• useRegleSchema(state, schema) は useRegle の代わりに使用します。r$ オブジェクトの動作は同じです。
• Standard Schema ライブラリであればどれでも使用できます。Zod、Valibot、ArkType は第一級のサポート対象です。
• useRules / refineRules を使うと、スキーマバリデーションと Regle のネイティブルールを組み合わせられます。
• InferInput を使うと、スキーマから状態の型を推論できます。

参考資料

トピック	説明	参考資料
スキーマライブラリ	Zod、Valibot、ArkType での useRegleSchema	schemas-libraries
Standard Schema	Standard Schema の仕様、useRules、refineRules、InferInput	schemas-standard-schema

関連スキル

• regle — useRegle を使ったフォームの設定、バリデーションプロパティ、エラーの表示。
• regle-rules — スキーマライブラリを使用しない場合のネイティブルール。
• regle-typescript — 型安全な出力と props の型指定。