Typescript에서 사용할 수 있는 라이브러리 Zod의 기초 사용법

zod.dev

🤔Zod 가 무엇인가요?

Zod is a TypeScript-first schema declaration and validation library.

Zod는 타입스크립트 우선 스키마 선언 및 검증 라이브러리 입니다.

🤔왜 Zod를 사용하나요?

타입스크립트는 컴파일 시점에서 타입을 검사합니다. 런타임에 동적으로 생성되는 값과 타입스크립트의 타입 간의 불일치가 발생하여 에러가 발생할 수 있는데요, 이를 방지할 수 있는 라이브러리가 바로 Zod입니다.

아래와 같은 상황이 런타임에 동적으로 생성되는 값과 타입스크립트 타입 간의 불일치가 발생하는 코드의 예 입니다.

interface User {
  id: number;
  name: string;
}

const Json = '{"id": 1323, "username": "lurgi"}';

try {
  const user: User = JSON.parse(Json);
  console.log(user.id);
  console.log(user.name);
} catch (error) {
  console.error('런타임 에러:', error);
}

/*
실행 결과
1323
undefined 
*/
//오류를 잡아내지 못하고 undefined를 찍는다.

🤨Zod를 어떻게 사용할까요?

위의 예시를 zod를 통해서 에러를 만들어 봅시다.

npm i zod

import { z } from "zod";

const schema = z.object({
  id: z.number(),
  name: z.string(),
});

type User = z.infer<typeof schema>;

const Json = '{"id": 1323, "username": "lurgi"}';

try {
  const user: User = schema.parse(Json);
  console.log(user.id);
  console.log(user.name);
} catch (error) {
  console.error("런타임 에러:", error);
}

/* 런타임 에러: ZodError: [
  {
    "code": "invalid_type",
    "expected": "object",
    "received": "string",
    "path": [],
    "message": "Expected object, received string"
  }
] */

기본적인 사용법은 위와 같습니다.

zod를 통해 만들어진 schema를 통해 타입을 만들고, parse를 할 수 있습니다.

동적으로 parse를 하는 과정에서 타입 유효성을 검사할 수 있기에 에러를 배출할 수 있습니다.

---

기본적인 사용방법은 위와 같습니다. 더 상세한 사용법을 익히기 위해서는 아래 공식 문서를 참고하세요!

GitHub - colinhacks/zod: TypeScript-first schema validation with static type inference