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)
  }
})