Zod は、TypeScript エコシステムで最も有名な検証ライブラリです。 Zod を使用すると、スキーマを作成し、スキーマに従ってデータを検証します。以下のスキーマを確認してください:

import { z } from 'zod'

const UserSchema = z.object({
  name: z.string().min(1),
  age: z.number({ coerce: true }).min(18),
  email: z.string().email(),
})

このスキーマは、次のようにオブジェクトを検証するために使用できます:

const data = {
  name: 'John Doe',
  age: 18,
  email: '[email protected]',
}

// If there is a validation error, it throws an error
const validatedData = UserSchema.parse(data)

// If there is a validation error, it returns an error object for you to handle later
const safeValidatedData = UserSchema.safeParse(data)
// => { success: false; error: ZodError }
// => { success: true; data: 'billie' }

Zod はデータに対してさまざまな種類の検証を実行できるため、詳細についてはドキュメントを必ずお読みください。

環境変数の検証

Zod を使用して process.env に存在する値を検証し、アプリケーションで環境変数を使用する前にそれらの値を処理することもできます。通常、私は以下の例のように、environment.ts ファイルを作成することを好みます:

import { z } from 'zod'

const environmentSchema = z.object({
  // Define the possible values for NODE_ENV, always leaving a default value:
  NODE_ENV: z.enum(['test', 'development', 'production']).default('production'),
  // Environment variables are always defined as strings. Here, convert the string to a number and set a default value:
  PORT: z.number({ coerce: true }).default(3000),
})

export const env = environmentSchema.parse(process.env)

次に、変数をインポートしてアプリケーション全体で使用します:

import Fastify from 'fastify'
import { env } from './environment.js'

const app = Fastify({ logger: true })
app.listen({ port: env.PORT }, (err) => {
  if (err) {
    app.log.error(err)
    process.exit(1)
  }
})