Zodとは？基本的な使い方や活用方法を徹底解説！【TypeScript/JavaScript】

npm install zod

import { z } from 'zod';

const schema = z.string().min(5, "文字列は5文字以上でなければなりません");

try {
    schema.parse("test"); // 失敗します
} catch (e) {
    console.error(e.errors); // エラー情報が出力されます
}

const userSchema = z.object({
    username: z.string().min(3, "ユーザー名は3文字以上でなければなりません"),
    email: z.string().email("無効なメールアドレスです"),
    age: z.number().int().positive("年齢は正の整数でなければなりません")
});

const userData = {
    username: "user",
    email: "user@example.com",
    age: 25
};

try {
    userSchema.parse(userData); // 正常なデータなのでエラーは発生しません
} catch (e) {
    console.error(e.errors); // エラーが発生した場合、エラーメッセージを表示
}

const numbersSchema = z.array(z.number().positive());

const numbers = [10, 20, 30];

try {
    numbersSchema.parse(numbers); // 正常な配列なのでエラーは発生しません
} catch (e) {
    console.error(e.errors); // エラーが発生した場合、エラーメッセージを表示
}

const schema = z.union([z.string(), z.number()]);

try {
    schema.parse("Hello"); // OK
    schema.parse(123); // OK
    schema.parse(true); // エラー
} catch (e) {
    console.error(e.errors); // エラー情報が出力されます
}

const emailSchema = z.string().email().refine(async (email) => {
    const user = await checkEmailExists(email); // データベースに問い合わせる非同期処理
    return !user; // ユーザーが既に存在していないことを確認
}, {
    message: "このメールアドレスはすでに使用されています",
});

async function validateEmail() {
    try {
        await emailSchema.parseAsync("user@example.com");
    } catch (e) {
        console.error(e.errors);
    }
}

validateEmail();

const numberSchema = z.number().min(0).max(100);

const schema = z.string().refine(value => value.startsWith("A"), {
    message: "Aで始まる文字列が必要です",
});

const schema = z.string().optional();

const schema = z.string().default("Default Value");