0Pricing
TypeScript Academy · 강의

공유 형식 패키지 전략

모노레포 전체에서 사용하는 전용 형식 패키지를 만듭니다.

공유 형식 패키지 전략은(는) CoddyKit의 무료 TypeScript Academy 강의입니다. 이것은 4개 중 3번째 강의입니다. 아래에서 전체 강의를 무료로 읽을 수 있으며, 내장 코드 에디터와 24/7 AI 튜터와 함께 브라우저에서 직접 실습할 수 있습니다. 이 강의는 TypeScript Academy 학습 경로의 일부이며, 진행 상황이 웹과 CoddyKit 앱에 동기화됩니다. TypeScript Academy 강의에는 총 4개의 강의가 포함되어 있습니다.

공유 타입 패키지가 필요한 이유

프런트엔드와 백엔드에서 타입을 공유하면 API 계약 간의 불일치가 사라집니다. 단일 기준을 사용하면 API 구조가 변경될 때 컴파일 시 오류를 확인할 수 있습니다.

// packages/types/src/index.ts
export interface User { id: string; name: string; email: string; }
export interface ApiResponse<T> { data: T; error?: string; }

패키지 구조

타입 패키지는 타입 내보내기만 포함하고 실행 시간 로직은 포함하지 않도록 최소화하십시오. 이렇게 하면 부수 효과가 없고 트리 셰이킹이 가능합니다.

packages/types/
├── src/
│   ├── index.ts      # re-exports all
│   ├── user.ts
│   ├── product.ts
│   └── api.ts
├── tsconfig.json
└── package.json

타입 패키지를 위한 tsconfig

JavaScript가 출력되지 않고 소비자가 참조하는 .d.ts 파일만 출력되도록 emitDeclarationOnly를 활성화하십시오.

{
  "compilerOptions": {
    "composite": true,
    "declaration": true,
    "emitDeclarationOnly": true,
    "outDir": "./dist",
    "rootDir": "./src"
  }
}

타입 패키지 사용하기

API와 웹 앱 모두에서 타입 패키지를 참조하고, 실행 시간의 오버헤드를 피하려면 import type으로 타입을 가져오십시오.

import type { User, ApiResponse } from "@myapp/types";

async function getUser(id: string): Promise<ApiResponse<User>> {
  // ...
}

직렬화에 안전한 타입 유지하기

클라이언트와 서버 간에 공유되는 타입에는 JSON으로 직렬화할 수 있는 값만 포함해야 합니다. Date 객체는 피하고 대신 string(ISO)을 사용하십시오.

// Good: serialization-safe
interface Event { id: string; createdAt: string; /* ISO date */ }
// Bad: Date is not JSON-serializable
interface Event { id: string; createdAt: Date; }

타입 패키지 버전 관리

타입 패키지의 버전을 시맨틱 버전 관리로 관리하십시오. 호환성을 깨뜨리는 변경 사항(필드 제거 또는 이름 변경)은 주 버전 증가에 해당합니다.

# Breaking change: major bump
npm version major
# Adding optional fields: minor bump
npm version minor

OpenAPI에서 타입 생성하기

openapi-typescript를 사용하여 OpenAPI 사양에서 타입 패키지를 생성하도록 자동화하십시오. 이렇게 하면 타입이 항상 백엔드와 일치합니다.

npx openapi-typescript ./api/openapi.yaml -o ./packages/types/src/api.ts

실행 시간 및 컴파일 시 타입에 Zod 사용하기

Zod 스키마로 타입을 정의하고 그로부터 TypeScript 타입을 추론하십시오. 실행 시간 유효성 검사와 정적 타입이 모두 동일한 원천에서 만들어집니다.

import { z } from "zod";
export const UserSchema = z.object({ id: z.string(), name: z.string() });
export type User = z.infer<typeof UserSchema>;

순환 의존성 방지하기

순환 의존성 연결을 방지하려면 타입 패키지가 다른 워크스페이스 패키지에서 가져오지 않도록 해야 합니다. 의존성 그래프에서 리프 노드로 유지하십시오.

// types/ should not import from ui/ or api/
// ui/ and api/ both import from types/

타입 정확성 테스트하기

tsd를 사용하여 공유 타입이 예상과 일치하는지 확인하는 타입 수준 단언을 작성하십시오.

import { expectType } from "tsd";
import type { User } from "@myapp/types";
expectType<User>({ id: "1", name: "Alice", email: "a@b.com" });

복습: 공유 타입 전략

공유 타입 패키지는 API 불일치를 없앱니다. 선언만 출력하고, 타입을 JSON으로 직렬화할 수 있게 유지하며, 시맨틱 버전 관리로 버전을 관리하고, 필요에 따라 OpenAPI에서 자동 생성하며, tsd로 테스트하십시오.

빠른 확인

공유 API 타입에서 Date 대신 string을 사용해야 하는 이유는 무엇입니까?

학습 내용

공유 타입 패키지는 API 계약을 위한 단일 기준입니다. 선언만 출력하고 JSON으로 안전하게 직렬화할 수 있도록 유지하며, 시맨틱 버전 관리로 버전을 관리하십시오. 필요에 따라 OpenAPI에서 생성하면 프런트엔드와 백엔드 간의 불일치를 없앨 수 있습니다.

자주 묻는 질문

“공유 형식 패키지 전략” 강의는 무료인가요?

네 — “공유 형식 패키지 전략” 전체 내용을 이 웹사이트에서 무료로 읽을 수 있습니다. 인터랙티브하게 실습하려면(내장 코드 에디터와 24/7 AI 튜터), CoddyKit PRO로 업그레이드하면 TypeScript Academy 강의 전체를 잠금 해제할 수 있습니다. TypeScript Academy 강의에는 총 4개의 강의가 포함되어 있습니다.

“공유 형식 패키지 전략”에서 뭘 배우나요?

모노레포 전체에서 사용하는 전용 형식 패키지를 만듭니다. 브라우저에서 직접 실행하는 실습 코드로 TypeScript Academy을(를) 배우며, 24/7 AI 튜터가 강의를 진행하면서 질문에 답변해줍니다.

TypeScript Academy을(를) 시작하는 데 경험이 필요한가요?

사전 경험은 필요하지 않습니다. CoddyKit의 TypeScript Academy은(는) 초급자부터 고급 학습자까지를 위해 구성되어 있으므로, 여기서 시작하거나 처음부터 시작할 수 있으며 자신의 속도대로 진행할 수 있습니다. 이것은 4개 중 3번째 강의입니다.

“공유 형식 패키지 전략” 강의는 얼마나 걸리나요?

대부분의 CoddyKit 강의는 약 5~10분이 소요됩니다. 각 강의는 간결하고 인터랙티브하여 꾸준한 진행이 가능하며, 웹과 앱에서 중단한 부분부터 바로 시작할 수 있습니다.

이 TypeScript Academy 강의에서 코드를 작성하고 실행할 수 있나요?

네. 모든 TypeScript Academy 강의에는 내장 코드 에디터가 포함되어 있으므로, 브라우저에서 바로 실제 코드를 작성하고 실행한 후 즉시 AI 피드백을 받을 수 있습니다 — 로컬 설정이 필요 없습니다.

이 강의의 모든 강의

  1. TypeScript 프로젝트 참조 이해하기
  2. TypeScript와 함께 사용하는 pnpm 작업 공간
  3. 공유 형식 패키지 전략
  4. 모노레포의 증분 빌드 및 캐시
← TypeScript Academy(으)로 돌아가기