Branded Type は、同じ string でも用途ごとにブランド(型を区別する情報)を付けて、別の型として区別する書き方です。検査を通った値だけにブランドを付けると、検査していない文字列は ID の型として渡せません。
S03 の修正は、parse が schema で値を検査することです。ブランドは検査済みの値だけを型で示す手段で、値の検査は行いません。現在のコードでは、VeterinarianId にブランドが付いていても、parse が any を経由して値をコピーするため、night-shift が通過します。
-
予約IDと獣医師IDは、どちらもUUIDの形をした文字列です。値を見ただけでは、どちらのIDか判別できません。
ブランドなし examples/session-02-solution/src/domain/appointment/appointmentId.tsimport { z } from "zod"; const schema = z.string().uuid(); export type AppointmentId = z.infer<typeof schema>; export const AppointmentId = { schema, parse: schema.parse } as const; -
ブランドなしのschemaは z.string().uuid() だけです。z.infer で得る AppointmentId 型の中身は string で、VeterinarianId 型も同じ string です。
ブランドなし examples/session-02-solution/src/domain/appointment/appointmentId.tsimport { z } from "zod"; const schema = z.string().uuid(); export type AppointmentId = z.infer<typeof schema>; export const AppointmentId = { schema, parse: schema.parse } as const; -
獣医師IDを受け取る関数に予約IDを渡しても、どちらの型も string であるため型検査は誤りを報告しません。取り違えは、実行して記録に異常が出てから発見されます。
ブランドなし examples/session-02-solution/src/domain/domain.test-types.tsconst acceptAppointmentId = (_id: AppointmentId): void => undefined; const acceptVeterinarianId = (_id: VeterinarianId): void => undefined; acceptAppointmentId(veterinarianId); acceptVeterinarianId(appointmentId); -
.brand<"AppointmentId">() を付けた schema が AppointmentId.schema で、推論される型は string に AppointmentId というブランドを追加した型です。獣医師IDの VeterinarianId.schema には VeterinarianId という別のブランドが付きます。
ブランドあり examples/session-03/src/domain/appointment/appointmentId.tsimport { z } from "zod"; const schema = z.string().uuid().brand<"AppointmentId">(); export type AppointmentId = z.infer<typeof schema>; export const AppointmentId = { schema, parse: schema.parse } as const; -
ブランドの違う値を渡すと、型検査が型エラーとして報告します。@ts-expect-error は、この行で型エラーが発生することを検証するための注釈です。
ブランドあり examples/session-03/src/domain/domain.test-types.tsconst acceptAppointmentId = (_id: AppointmentId): void => undefined; const acceptVeterinarianId = (_id: VeterinarianId): void => undefined; // @ts-expect-error VeterinarianIdをAppointmentIdとして使えません。 acceptAppointmentId(veterinarianId); // @ts-expect-error AppointmentIdをVeterinarianIdとして使えません。 acceptVeterinarianId(appointmentId); -
ブランドは型検査のときだけ使われます。TypeScript を JavaScript に変換すると型は消え、実行時の値はブランドなしと同じ文字列のままです。
ブランドあり examples/session-03/src/domain/domain.test-types.tsconst acceptAppointmentId = (_id: AppointmentId): void => undefined; const acceptVeterinarianId = (_id: VeterinarianId): void => undefined; // @ts-expect-error VeterinarianIdをAppointmentIdとして使えません。 acceptAppointmentId(veterinarianId); // @ts-expect-error AppointmentIdをVeterinarianIdとして使えません。 acceptVeterinarianId(appointmentId); -
ブランドが付いた値を作る正規の入口は parse です。parse は文字列がUUIDの形かを検査し、通った値だけを AppointmentId 型として返します。as で型だけを付ける回避は、別に Linter で検出します。
ブランドあり examples/session-03/src/domain/domain.test-types.tsimport { AppointmentId, VeterinarianId } from "./appointment/index.js"; import { clinicFixture } from "../../../fixtures/clinic.js"; const appointmentId = AppointmentId.parse(clinicFixture.appointmentId); const veterinarianId = VeterinarianId.parse(clinicFixture.veterinarianId);clinicFixtureは、このハンズオンのテスト用の固定データです。 -
UUIDの形でない文字列は AppointmentId.parse を通らず、AppointmentId 型の値は作られません。この parse は正しいと分かっている値に使い、誤りはコードの誤りとして S02 の fail-fast と同じく例外で中断します。外部入力には、検査に失敗すると Err を返す StartExaminationInput.parse を使います。
例外を投げる parse: 検査に失敗すると例外を投げます。
parse: schema.parse AppointmentId.parse("night-shift")Err を返す parse: 検査に失敗すると Err を返します。
parse: schemaResult(schema) StartExaminationInput.parse(raw)