Joi

クイックスタート

const Joi = require('@hapi/joi');

const schema = Joi.object({
    name: Joi.string().min(1).max(100).required(),
    age: Joi.number().integer().min(0),
    email: Joi.string().email()
});

const { error, value } = schema.validate(input);

重要なルール

1. スキーマは不変 - すべてのメソッドは新しいスキーマインスタンスを返します。決して変更しないこと
2. 境界で検証する - 入力の境界で validate() または attempt() を使用します。検証を参照
3. 型は基本から拡張 - すべての型は any() から継承します。型の概要を参照
4. クロスフィールド参照に Refs を使用 - フィール間の動的な値に Joi.ref() を使用します。参照を参照
5. カスタム型に Extend を使用 - カスタム型を作成するには Joi.extend() を使用します。拡張機能を参照

ワークフロー

1. 型を選択 - すべての組み込み型については型の概要を参照
2. 制約を追加 - .min()、.max()、.pattern()、.valid() などのルールをチェーン
3. スキーマを構成 - Joi.object()、Joi.array()、Joi.alternatives() をネスト
4. 条件付きロジックを追加 - 動的スキーマに .when() を使用します。条件付きロジックを参照
5. エラーをカスタマイズ - .messages() または .error() でメッセージをオーバーライドします。エラーを参照

重要なパターン

トピック	リファレンス
すべての組み込み型	型
検証とオプション	検証
参照とテンプレート	参照
条件付きスキーマ	条件付きロジック
エラーハンドリング	エラー
カスタム拡張機能	拡張機能
メタデータと内省	メタデータ
共通メソッド (any)	any
テストパターン	テスト