04 타입 확장하기·좁히기
4.3 타입 좁히기 - 식별할 수 있는 유니온
종종 태그된 유니온(Tagged Union)으로도 불리는 식별할 수 있는 유니온(Discriminated Unions)은 타입 좁히기에 널리 사용되는 방식이다.
1. 에러 정의하기
유효성 에러가 발생하면 사용자에게 다양한 방식으로 에러를 보여 주는데 우아한형제들에서는 이 에러를 크게 텍스트 에러, 토스트 에러, 얼럿 에러로 분류한다.
이들 모두 유효성 에러로 에러 코드와 에러 메시지를 가지고 있으며, 에러 노출 방식에 따라 추가로 필요한 정보가 있을 수 있다.
예를 들어 토스트 에러는 토스트를 얼마 동안 띄울 것인지에 대한 정보가 필요하다.
각 에러 타입을 다음과 같이 정의했다고 해보자.
type TextError = {
errorCode: string;
errorMessage: string;
}
type ToastError = {
errorCode: string;
errorMessage: string;
toastShowDuration: number; // 토스트를 띄워줄 시간
}
type AlertError = {
errorCode: string;
errorMessage: string;
onConfirm: () => void; // 얼럿 창의 확인 버튼을 누른 뒤 액션
}
이 에러 타입의 유니온 타입을 원소로 하는 배열을 정의해보면 다음과 같을 것이다.
type ErrorFeedbackType = TextError | ToastError | AlertError
const errorArr: ErrorFeedbackType[] = [
{ errorCode: '100', errorMessage: '텍스트 에러' },
{ errorCode: '200', errorMessage: '토스트 에러', toastShowDuration: 3000 },
{ errorCode: '300', errorMessage: '얼럿 에러', onConfirm: () => {} },
]
여기서 해당 배열에 에러 타입별로 정의한 필드를 가지는 에러 객체가 포함되길 원한다고 해보자.
즉, ToasError의 toastShowDuration 필드와 AlertError의 onConfirm 필드를 모두 가지는 객체에 대해서는 타입 에러를 뱉어야 할 것이다.
const errorArr: ErrorFeedbackType[] = [
// ...
{
errorCode: '999',
errorMessage: '잘못된 에러',
toastShowDuration: 3000,
onConfirm: () => {},
}, // expected error
]
하지만 이 코드를 작성했을 때 자바스크립트는 덕 타이핑 언어이기 때문에 별도의 타입 에러를 뱉지 않는 것을 확인할 수 있다.
이런 상황에서 타입 에러가 발생하지 않는다면 앞으로의 개발 과정에서 의미를 알 수 없는 무수한 에러 객체가 생겨날 위험성이 커진다.
2. 식별할 수 있는 유니온
따라서 에러 타입을 구분할 방법이 필요하다.
각 타입이 비슷한 구조를 가지지만 서로 호환되지 않도록 만들어주기 위해서는 타입들이 서로 포함 관계를 가지지 않도록 정의해야 한다.
이때 적용할 수 있는 방식이 바로 식별할 수 있는 유니온을 활용하는 것이다.
식별할 수 있는 유니온이란 타입 간의 구조 호환을 막기 위해 타입마다 구분할 수 있는 판별자(discriminant)를 달아주어 포함 관계를 제거하는 것이다.
판별자의 개념으로 errorType이라는 필드를 새로 정의해보자.
각 에러 타입마다 이 필드에 대해 다른 값을 가지도록 하여 판별자를 달아주면 이들은 포함 관계를 벗어나게 된다.
type TextError = {
errorType: 'TEXT';
errorCode: string;
errorMessage: string;
}
type ToastError = {
errorType: 'TOAST';
errorCode: string;
errorMessage: string;
toastShowDuration: number; // 토스트를 띄워줄 시간
}
type AlertError = {
errorType: 'ALERT';
errorCode: string;
errorMessage: string;
onConfirm: () => void; // 얼럿 창의 확인 버튼을 누른 뒤 액션
}
에러 객체에 대한 타입을 위와 같이 정의한 상태에서 errorArr을 새로 정의해보자.
type ErrorFeedbackType = TextError | ToastError | AlertError
const errorArr: ErrorFeedbackType[] = [
{ errorType: 'TEXT', errorCode: '100', errorMessage: '텍스트 에러' },
{ errorType: 'TOAST', errorCode: '200', errorMessage: '토스트 에러', toastShowDuration: 3000 },
{ errorType: 'ALERT', errorCode: '300', errorMessage: '얼럿 에러', onConfirm: () => {} },
{ errorType: 'TEXT', errorCode: '999', errorMessage: '잘못된 에러', toastShowDuration: 3000, onConfirm: () => {} },
// Error: Object literal my only specify known properties, and 'toastShowDuration' does not exist in type 'TextError'
{ errorType: 'TOAST', errorCode: '210', errorMessage: '토스트 에러', onConfirm: () => {} },
// Error: Object literal my only specify known properties, and 'onConfirm' does not exist in type 'ToastError'
{ errorType: 'ALERT', errorCode: '310', errorMessage: '얼럿 에러', toastShowDuration: 5000 },
// Error: Object literal my only specify known properties, and 'toastShowDuration' does not exist in type 'AlertError'
]
우리가 처음에 기대했던 대로 정확하지 않은 에러 객체에 대해 타입 에러가 발생하는 것을 확인할 수 있다.
3. 식별할 수 있는 유니온의 판별자 선정
식별할 수 있는 유니온을 사용할 때 주의할 점이 있다.
식별할 수 있는 유니온의 판별자는 유닛 타입(unit type)으로 선언되어야 정상적으로 동작한다.
유닛 타입은 다른 타입으로 쪼개지지 않고 오직 하나의 정확한 값을 가지는 타입을 말한다.
null, undefined, 리터럴 타입을 비롯해 true, 1 등 정확한 값을 나타내는 타입이 유닛 타입에 해당한다.
반면에 다양한 타입을 할당할 수 있는 void, string, number와 같은 타입은 유닛 타입으로 적용되지 않는다.
공식 깃허브의 이슈 탭을 살펴보면 식별할 수 있는 유니온의 판별자로 사용할 수 있는 타입을 다음과 같이 정의하고 있다.
- 리터럴 타입이어야 한다.
- 판별자로 선정한 값에 적어도 하나 이상의 유닛 타입이 포함되어야 하며, 인스턴스화할 수 있는 타입(instantiable type)은 포함되지 않아야 한다.
다음 예시를 살펴보자.
interface A {
value: 'a'; // unit type
answer: 1;
}
interface B {
value: string; // not unit type
answer: 2;
}
interface C {
value: Error; // not unit type
answer: 3;
}
type Unions = A | B | C
function handle(param: Unions) {
/** 판별자가 value일 때 */
param.answer; // 1 | 2 | 3
// 'a'가 리터럴 타입이므로 타입이 좁혀진다
// 단, 이는 string 타입에 포함되므로 param은 A 또는 B 타입으로 좁혀진다
if (param.value === 'a') {
param.answer; // 1 | 2 return;
}
// 유닛 타입이 아니거나 인스턴스화할 수 있는 타입일 경우 타입이 좁혀지지 않는다
if (typeof param.value === 'string') {
param.answer; // 1 | 2 | 3 return;
}
if (param.value instanceof Error) {
param.answer; // 1 | 2 | 3 return;
}
/** 판별자가 answer일 때 */
param.value; // string | Error
// 판별자가 유닛 타입이므로 타입이 좁혀진다
if (param.answer === 1) {
param.value; // 'a'
}
}
이 코드에서 판별자가 value일 때 판별자로 선정한 값 중 ‘a’만 유일하게 유닛 타입이다.
이때만 유닛 타입을 포함하고 있기 때문에 타입이 좁혀지는 것을 볼 수 있다.
판별자가 answer일 때를 생각해보면 판별자가 모두 유닛 타입이므로 타입이 정상적으로 좁혀진다.