TypeScript Zodの使い方 まとめ
techZODとは
データの検証用ライブラリ データスキーマを定義し、単純なデータ型から複雑なオブジェクトまで様々なデータを検証することができる
参考
基本的な使い方
import z from "zod"
const <zod-object> = z.object(<data-schema>)
const result =<zod-object>.safeParse(<object>)
if (!result.success){
result.error;
} else {
result.data;
}
data-schemaの定義
const categoryKeys = ["tech", "life", "idea"] as [string, string[]];
const frontMatterSchema = z.object({
title: z.string({ error: "タイトルは必須です" }),
category: z.enum(categoryKeys, {
error: `${categoryKeys.join(",")}のいずれかが必須です`,
}),
date: z.date({ error: "日付は必須です" }),
});
エラーになると...?
result.errorの戻り値
/* [
{
expected: 'string',
code: 'invalid_type',
path: [ 'username' ],
message: 'Invalid input: expected string'
},
{
expected: 'number',
code: 'invalid_type',
path: [ 'xp' ],
message: 'Invalid input: expected number'
}
] */
この戻り値を使って、エラーメッセージをカスタマイズし処理を行う
expectedcodepathmessage
処理を止めたいなら
if (!result.success) {
throw new Error(`記事のfrontmatterが不正です。${result.error.message}`);
}