생성할 수 없는 유형을 사용하는 TypeScript의 풍부한 컴파일 시간 예외

Susan Sarandon
풀어 주다: 2024-10-29 18:40:02
원래의
971명이 탐색했습니다.

Rich Compile-Time Exceptions in TypeScript Using Unconstructable Types

TypeScript의 유형 시스템은 강력하지만 오류 메시지는 때때로 난해하고 이해하기 어려울 수 있습니다. 이 기사에서는 생성할 수 없는 유형을 사용하여 명확하고 설명이 포함된 컴파일 시간 예외를 생성하는 패턴을 살펴보겠습니다. 이 접근 방식은 유용한 오류 메시지로 잘못된 상태를 표시할 수 없게 만들어 런타임 오류를 방지하는 데 도움이 됩니다.

패턴: 사용자 정의 메시지가 포함된 구성 불가능한 유형

먼저 핵심 패턴을 분석해 보겠습니다.

// Create a unique symbol for our type exception
declare const TypeException: unique symbol;

// Basic type definitions
type Struct = Record<string, any>;
type Funct<T, R> = (arg: T) => R;
type Types<T> = keyof T & string;
type Sanitize<T> = T extends string ? T : never;

// The core pattern for type-level exceptions
export type Unbox<T extends Struct> = {
    [Type in Types<T>]: T[Type] extends Funct<any, infer Ret>
        ? (arg: Ret) => any
        : T[Type] extends Struct
        ? {
              [TypeException]: `Variant <${Sanitize<Type>}> is of type <Union>. Migrate logic to <None> variant to capture <${Sanitize<Type>}> types.`;
          }
        : (value: T[Type]) => any;
};
로그인 후 복사
로그인 후 복사

작동 방식

  1. TypeException은 오류 메시지의 특수 키 역할을 하는 고유 기호입니다
  2. 잘못된 유형 상태가 발생하면 TypeException 속성이 있는 객체 유형을 반환합니다
  3. 이 유형은 런타임에 구성할 수 없으므로 TypeScript에서 사용자 정의 오류 메시지를 표시해야 합니다
  4. 오류 메시지에는 템플릿 리터럴을 사용하는 유형 정보가 포함될 수 있습니다

예 1: 사용자 정의 오류가 있는 변형 처리

다음은 변형 유형에 이 패턴을 사용하는 방법을 보여주는 예입니다.

type DataVariant = 
    | { type: 'text'; content: string }
    | { type: 'number'; value: number }
    | { type: 'complex'; nested: { data: string } };

type VariantHandler = Unbox<{
    text: (content: string) => void;
    number: (value: number) => void;
    complex: { // This will trigger our custom error
        [TypeException]: `Variant <complex> is of type <Union>. Migrate logic to <None> variant to capture <complex> types.`
    };
}>;

// This will show our custom error at compile time
const invalidHandler: VariantHandler = {
    text: (content) => console.log(content),
    number: (value) => console.log(value),
    complex: (nested) => console.log(nested) // Error: Type has unconstructable signature
};
로그인 후 복사

예 2: 재귀적 유형 유효성 검사

다음은 재귀 유형과 함께 패턴을 사용하는 방법을 보여주는 더 복잡한 예입니다.

type TreeNode<T> = {
    value: T;
    children?: TreeNode<T>[];
};

type TreeHandler<T> = Unbox<{
    leaf: (value: T) => void;
    node: TreeNode<T> extends Struct
        ? {
              [TypeException]: `Cannot directly handle node type. Use leaf handler for individual values.`;
          }
        : never;
}>;

// Usage example - will show custom error
const invalidTreeHandler: TreeHandler<string> = {
    leaf: (value) => console.log(value),
    node: (node) => console.log(node) // Error: Cannot directly handle node type
};
로그인 후 복사

예시 3: 유형 상태 검증

다음은 패턴을 사용하여 유효한 유형 상태 전환을 적용하는 방법입니다.

type LoadingState<T> = {
    idle: null;
    loading: null;
    error: Error;
    success: T;
};

type StateHandler<T> = Unbox<{
    idle: () => void;
    loading: () => void;
    error: (error: Error) => void;
    success: (data: T) => void;
    // Prevent direct access to state object
    state: LoadingState<T> extends Struct
        ? {
              [TypeException]: `Cannot access state directly. Use individual handlers for each state.`;
          }
        : never;
}>;

// This will trigger our custom error
const invalidStateHandler: StateHandler<string> = {
    idle: () => {},
    loading: () => {},
    error: (e) => console.error(e),
    success: (data) => console.log(data),
    state: (state) => {} // Error: Cannot access state directly
};
로그인 후 복사

이 패턴을 사용해야 하는 경우

이 패턴은 다음과 같은 경우에 특히 유용합니다.

  1. 컴파일 시 특정 유형 조합을 방지해야 합니다
  2. 유형 위반에 대해 명확하고 설명적인 오류 메시지를 제공하려는 경우
  3. 특정 작업을 제한해야 하는 복잡한 유형의 계층 구조를 구축하고 있습니다
  4. 유용한 오류 메시지를 통해 개발자에게 올바른 사용 패턴을 안내해야 합니다

기술적인 세부사항

패턴이 내부적으로 어떻게 작동하는지 분석해 보겠습니다.

// Create a unique symbol for our type exception
declare const TypeException: unique symbol;

// Basic type definitions
type Struct = Record<string, any>;
type Funct<T, R> = (arg: T) => R;
type Types<T> = keyof T & string;
type Sanitize<T> = T extends string ? T : never;

// The core pattern for type-level exceptions
export type Unbox<T extends Struct> = {
    [Type in Types<T>]: T[Type] extends Funct<any, infer Ret>
        ? (arg: Ret) => any
        : T[Type] extends Struct
        ? {
              [TypeException]: `Variant <${Sanitize<Type>}> is of type <Union>. Migrate logic to <None> variant to capture <${Sanitize<Type>}> types.`;
          }
        : (value: T[Type]) => any;
};
로그인 후 복사
로그인 후 복사

기존 접근 방식에 비해 이점

  1. 오류 메시지 지우기: TypeScript의 기본 유형 오류 대신 무엇이 잘못되었는지 정확하게 설명하는 사용자 정의 메시지를 받게 됩니다
  2. 컴파일 시간 안전성: 모든 오류는 런타임이 아닌 개발 중에 포착됩니다
  3. 자체 문서화: 오류 메시지에는 문제 해결 방법에 대한 지침이 포함될 수 있습니다
  4. 유형 안전: 완전한 유형 안전성을 유지하면서 더 나은 개발자 경험을 제공합니다
  5. 런타임 비용 제로: 모든 검사는 런타임 오버헤드 없이 컴파일 타임에 이루어집니다

결론

사용자 정의 오류 메시지와 함께 생성할 수 없는 유형을 사용하는 것은 자체 문서화 유형 제약 조건을 생성하기 위한 강력한 패턴입니다. TypeScript의 유형 시스템을 활용하여 컴파일 타임에 명확한 지침을 제공함으로써 개발자가 런타임 문제가 발생하기 전에 문제를 포착하고 수정할 수 있도록 돕습니다.

이 패턴은 특정 조합이 유효하지 않은 복잡한 유형 시스템을 구축할 때 특히 유용합니다. 유효하지 않은 상태를 표현할 수 없게 만들고 명확한 오류 메시지를 제공함으로써 유지 관리가 용이하고 개발자 친화적인 TypeScript 코드를 만들 수 있습니다.

위 내용은 생성할 수 없는 유형을 사용하는 TypeScript의 풍부한 컴파일 시간 예외의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!

원천:dev.to
본 웹사이트의 성명
본 글의 내용은 네티즌들의 자발적인 기여로 작성되었으며, 저작권은 원저작자에게 있습니다. 본 사이트는 이에 상응하는 법적 책임을 지지 않습니다. 표절이나 침해가 의심되는 콘텐츠를 발견한 경우 admin@php.cn으로 문의하세요.
저자별 최신 기사
인기 튜토리얼
더>
최신 다운로드
더>
웹 효과
웹사이트 소스 코드
웹사이트 자료
프론트엔드 템플릿
회사 소개 부인 성명 Sitemap
PHP 중국어 웹사이트:공공복지 온라인 PHP 교육,PHP 학습자의 빠른 성장을 도와주세요!