ブログblog

Zodとは

Writer: tokuyasu 更新日:2024/04/19

こんにちは、デジナーレ福岡オフィスの徳安です。
この記事では、「Zod」について紹介します。

「Zod」とは

Zodとは、TypeScript向けの
スキーマ宣言とデータ検証のためのライブラリ
1つの定義から、TypeScriptの型定義
キーマバリデーションの定義を生成できる為、
Typescriptとの相性が非常に良い。
依存パッケージが無いことや
バンドルサイズが小さいといった特徴もある。
Zodを使用すると、
型安全な方法でデータ構造を定義し、
それに基づいてデータを検証できる

基本的な使い方

インストール方法

 

スキーマメソッド

*.parse

.parse(data: unknown): T
任意の Zod スキーマを指定、
.parseメソッドを呼び出し、
(.parse(data))引数に、対象の値を入れることで、
対象の値が有効であるかを検証することができる。
エラーの場合は、ZodErrorがスローされる。

<例>

*.safeParse

.safeParse(data:unknown): { success: true; data: T; }
| { success: false; error: ZodError; }

検証が失敗したときに ZodErrorをスローしたくない場合は、
.safeParseを使用する。
正常に解析されたデータを含むオブジェクト
または検証の問題に関する詳細情報を含む
ZodError インスタンスを返す
<例>

stringのschemaに用意されたメソッド

<例>

ネストしたり値をオプショナルにしたりと、
自由度が高く定義することもできる。

エラーメッセージのカスタマイズ

追加の引数を渡し、
エラーメッセージをカスタマイズすることもできる。

<例>

 オブジェクト

z.objectを使用して
オブジェクトスキーマを定義できる

また、z.infer<typeofSchema>を使用して、
任意のスキーマから 型を生成できる

<例>

 

ここまで読み進めていただきありがとうございます。