ホーム 全セッション S03

Zod: 1つの schema からの型の生成

7 / 18 目安 1.5分

ページ一覧

事前知識: Result で結果を返せるようになりました。次は、実行時に値を検査する手段が必要です。

型は実行時に消えるため、検査には実行時に残る値が必要です。Zod(TypeScript 向けの検査ライブラリ)は、その値を schema(値の形の条件を表す、実行時に残る値)として定義します。文字列が UUID の形かを検証する schema は、z.string().uuid() で定義します。

1つの schema から型を取り出す仕組み 上の帯は型検査のとき(TypeScript)、下の帯は実行時(JavaScript)です。JavaScript に変換すると型は消えるので、下の帯に型は残りません。schema は実行時の値であるため下の帯にあり、z.infer の矢印だけが上の帯の型へ伸びます。同じ名前 StartExaminationInput を、取り出した型と schema を持つ値の両方に付けます。 型検査のとき(TypeScript) JavaScript に変換すると、 型は消える 実行時(JavaScript) 型は残らない 型 z.infer で 取り出した型 schema z.object({ z.string().uuid() z.string().uuid() }) z.infer<typeof schema> StartExaminationInput 型として StartExaminationInput 値として
  1. TypeScript の型は、型検査のときだけ使われます。JavaScript に変換すると型は消えます。実行時に受け取った値が型のとおりかどうかは、型とは別のコードで検証する必要があります。

  2. z.object は、項目ごとの schema をまとめて、オブジェクト全体の schema を作ります。この例では、2つの項目がどちらも z.string().uuid() です。

    説明用の短い例
    import { z } from "zod";
    
    const schema = z.object({
      appointmentId: z.string().uuid(),
      veterinarianId: z.string().uuid(),
    });
    
    export type StartExaminationInput = z.infer<typeof schema>;
    export const StartExaminationInput = { schema } as const;
  3. 型は schema から取り出します。z.infer<typeof schema> は、schema が受け入れる値の型です。typeof は、値である schema の型を、型を指定する場所で使うための書き方です。型を手動で定義しないため、schema を修正すると型も同じように変わります。

    説明用の短い例
    import { z } from "zod";
    
    const schema = z.object({
      appointmentId: z.string().uuid(),
      veterinarianId: z.string().uuid(),
    });
    
    export type StartExaminationInput = z.infer<typeof schema>;
    export const StartExaminationInput = { schema } as const;
  4. TypeScript では、型と値に同じ名前を付けられます。この例の StartExaminationInput は、z.infer で取り出した型と、schema を持つ値の両方の名前です。

    説明用の短い例
    import { z } from "zod";
    
    const schema = z.object({
      appointmentId: z.string().uuid(),
      veterinarianId: z.string().uuid(),
    });
    
    export type StartExaminationInput = z.infer<typeof schema>;
    export const StartExaminationInput = { schema } as const;