Merge

두 객체 타입을 깊이 병합한 타입을 만들어요.

type Result = Merge<Target, Source>;

사용법

Merge<T, S>

두 객체를 깊이 병합한 결과의 타입이 필요할 때 사용해요. 예를 들어 merge로 기본 설정에 덮어쓰기를 적용한 결과의 타입을 표현할 수 있어요.

import type { Merge } from 'es-toolkit/types';

type Defaults = { host: string; port: number };
type Overrides = { debug: boolean };

type Config = Merge<Defaults, Overrides>;
// => { host: string; port: number; debug: boolean }

중첩 객체도 병합할 수 있어요. TypeScript 기본 병합 타입 T & S에서는 중첩 객체가 병합되지 않지만, Merge 타입을 사용하면 병합할 수 있어요.

import type { Merge } from 'es-toolkit/types';

type Target = { server: { host: string; port: number } };
type Source = { server: { tls: boolean } };

type Result = Merge<Target, Source>;
// => { server: { host: string; port: number; tls: boolean } }

두 배열 타입을 병합하면, 튜플은 인덱스별로 병합되고 그 외 배열은 양쪽 요소를 모두 담는 배열 타입이 돼요.

import type { Merge } from 'es-toolkit/types';

type Result = Merge<{ list: number[] }, { list: string[] }>;
// => { list: Array<string | number> }

type Tuple = Merge<[1, 2, 3], ['a']>;
// => ['a', 2, 3]

겹치는 키가 있을 때는 두 번째 객체의 값 타입을 사용해요. TypeScript 기본 병합 타입 T & S에서는 겹치는 키에 해당하는 값이 never로 표시되지만, Merge 타입을 사용하면 두 번째 객체의 값 타입이 사용돼요.

import type { Merge } from 'es-toolkit/types';

type Target = { id: string; value: string };
type Source = { value: number };

type Result = Merge<Target, Source>;
// => { id: string; value: number }

type Broken = Target & Source;
// => { id: string; value: never } (string & number는 never가 돼요)

같은 타입의 두 객체를 병합하면 그 타입이 그대로 나와요. string[] | string[][] 같은 유니온 타입이 들어 있어도 마찬가지예요.

import type { Merge } from 'es-toolkit/types';

type Options = { value: string[] | string[][] };

type Result = Merge<Options, Options>;
// => { value: string[] | string[][] }

같은 키가 있으면 두 번째 객체의 타입이 그대로 결과가 돼요.

원시 값, Date, Map, Set, 함수처럼 단순한 객체가 아닌 타입을 병합하면 두 번째 값의 타입을 사용해요.

import type { Merge } from 'es-toolkit/types';

type Target = { createdAt: Date; onChange: () => void; label: string };
type Source = { createdAt: string; onChange: (value: string) => void; label: 'a' | 'b' };

type Result = Merge<Target, Source>;
// => { createdAt: string; onChange: (value: string) => void; label: 'a' | 'b' }

첫 번째 객체에서 null이나 undefined일 수 있던 값도, 두 번째 객체에 값이 있으면 결과 타입에서는 사라져요.

import type { Merge } from 'es-toolkit/types';

type Defaults = { retry?: { count: number }; tags: string[] | null };
type Overrides = { retry: { count: number }; tags: string[] };

type Result = Merge<Defaults, Overrides>;
// => { retry: { count: number }; tags: string[] }

타입 파라미터

• T: 타깃 객체의 타입이에요.
• S: T에 병합할 소스 객체의 타입이에요.