Zodスキーマ入門
TypeScriptファーストのスキーマ宣言・バリデーションライブラリであるZodと、その基本型について学びます。
「Zodスキーマ入門」はCoddyKit上の無料tRPC End-to-End Type Safe APIsレッスンです。 これはレッスン1/4です。 下記で完全なレッスンを無料で読むことができます。その後、ブラウザ内の組み込みコードエディタと24時間対応のAIチューターでハンズオン演習できます。 これはtRPC End-to-End Type Safe APIs学習パスの一部であり、ウェブとCoddyKitアプリ全体で進捗が同期されます。 tRPC End-to-End Type Safe APIsコースには全4レッスンが含まれています。
このレッスンの一部はまだ翻訳されておらず、英語で表示されています。
What is Zod?
Welcome to Zod! It's a powerful, TypeScript-first validation library. Think of it as a guardian for your data.
Zod helps ensure that the data entering your application (from APIs, forms, etc.) matches the types you expect, even at runtime.
Why Use Zod? Type Safety!
TypeScript provides type safety during development, but what about data received from a server or user input? That data doesn't have TypeScript types.
Zod bridges this gap! It allows you to define a schema, validate runtime data against it, and automatically infer a TypeScript type from that schema. This gives you end-to-end type safety.
Zod's Basic Building Blocks
Zod schemas are created using the z object. Let's look at the most fundamental types: strings, numbers, and booleans.
z.string(): For text values.z.number(): For numeric values.z.boolean(): For true/false values.
These are your starting points for defining data shapes.
Declaring a String Schema
A string schema is simple to declare. You then use the .parse() method to validate data against it. If the data doesn't match, Zod throws an error.
Try running this example to see a valid string being parsed:
import { z } from 'zod';
function runExample() {
const usernameSchema = z.string();
const validUsername = "CoddyUser";
const parsedUsername = usernameSchema.parse(validUsername);
console.log(`Parsed: ${parsedUsername}`);
}
runExample();Handling String Validation Errors
What happens if you try to parse data that isn't a string? Zod throws a ZodError. It's good practice to wrap .parse() calls in a try...catch block.
Run this code to see Zod catch an invalid type:
import { z } from 'zod';
function runExample() {
const usernameSchema = z.string();
try {
const invalidUsername = 123; // Not a string!
usernameSchema.parse(invalidUsername);
} catch (error: any) {
console.log(`Error: ${error.message.split('\n')[0]}`);
}
}
runExample();Number & Boolean Schemas
Number and boolean schemas work similarly. They ensure the data is of the correct primitive type. This prevents unexpected errors later in your application.
Let's see how to define and use them:
import { z } from 'zod';
function runExample() {
const ageSchema = z.number();
const isActiveSchema = z.boolean();
const validAge = ageSchema.parse(30);
console.log(`Age: ${validAge}`);
const validStatus = isActiveSchema.parse(true);
console.log(`Active: ${validStatus}`);
try {
ageSchema.parse("twenty"); // Invalid!
} catch (error: any) {
console.log(`Error (Age): ${error.message.split('\n')[0]}`);
}
}
runExample();Making Fields Optional
Sometimes a piece of data might not always be present. Zod provides the .optional() method for this. It makes a schema accept undefined in addition to its base type.
Note that .optional() allows undefined, but not null by default.
import { z } from 'zod';
function runExample() {
const taglineSchema = z.string().optional();
const withTagline = taglineSchema.parse("Hello World!");
console.log(`With tagline: ${withTagline}`);
const withoutTagline = taglineSchema.parse(undefined);
console.log(`Without tagline: ${withoutTagline}`);
try {
taglineSchema.parse(null); // Optional doesn't allow null!
} catch (error: any) {
console.log(`Error (null): ${error.message.split('\n')[0]}`);
}
}
runExample();Exact Values with Literals
What if you need a field to have a very specific, fixed value? Zod's .literal() method is perfect for this. It ensures the parsed value is exactly what you define.
This is useful for enum-like fields where values are known beforehand.
import { z } from 'zod';
function runExample() {
const statusSchema = z.literal("pending");
const validStatus = statusSchema.parse("pending");
console.log(`Valid status: ${validStatus}`);
try {
statusSchema.parse("completed"); // Not 'pending'!
} catch (error: any) {
console.log(`Error (status): ${error.message.split('\n')[0]}`);
}
}
runExample();Building Blocks for Complex Data
You've now seen the basic types and modifiers in Zod. While simple on their own, these are the fundamental building blocks.
In upcoming lessons, you'll learn how to combine these basic schemas to define much more complex data structures, like objects and arrays, ensuring robust validation for your entire application.
Check Your Zod Basics!
Which Zod schema correctly validates a variable that must be the string "admin" or optionally a number?
Zod Basics Recap
Great job! You've taken your first steps into Zod, understanding its core purpose and basic types.
- Zod provides runtime validation for TypeScript data.
z.string(),z.number(),z.boolean()define basic types..parse()validates data and infers types.- Use
try...catchfor error handling. .optional()allowsundefinedvalues.z.literal()enforces exact fixed values.
These skills are foundational for building robust, type-safe applications!
よくある質問
「Zodスキーマ入門」レッスンは無料ですか?
はい。「Zodスキーマ入門」の完全なテキストはこのウェブで無料で読めます。インタラクティブに演習し(組み込みコードエディタと24時間対応のAIチューター)、tRPC End-to-End Type Safe APIsコースの残りをアンロックするには、CoddyKit PROにアップグレードしてください。 tRPC End-to-End Type Safe APIsコースには全4レッスンが含まれています。
「Zodスキーマ入門」で何を学びますか?
TypeScriptファーストのスキーマ宣言・バリデーションライブラリであるZodと、その基本型について学びます。 ブラウザで直接実行するハンズオンコードでtRPC End-to-End Type Safe APIsを演習し、24時間対応のAIチューターがレッスンを進める中での質問に答えます。
tRPC End-to-End Type Safe APIsを始めるのに経験は必要ですか?
事前経験は必要ありません。CoddyKitのtRPC End-to-End Type Safe APIsは初級者から上級者向けに構成されているため、ここから始めるか最初から始めて、自分のペースで進むことができます。 これはレッスン1/4です。
「Zodスキーマ入門」レッスンにはどのくらい時間がかかりますか?
ほとんどのCoddyKitレッスンは約5~10分かかります。各レッスンはコンパクトでインタラクティブなので、着実に進歩し、ウェブとアプリ全体で正確に前回の場所から再開できます。
このtRPC End-to-End Type Safe APIsレッスンでコードを書いて実行できますか?
はい。すべてのtRPC End-to-End Type Safe APIsレッスンに組み込みコードエディタが含まれているため、ブラウザでリアルコードを書いて実行し、即座のAIフィードバックを取得できます。ローカル設定は不要です。