아이템 51 - 의존성 분리를 위해 미러 타입 사용하기

이장에서의 핵심은 라이브러리를 작성중일 때,  의존이 필요한 라이브러리가 구현과 상관없이 타입만 필요하다면 모든 라이브러리를 불러오지 않고 구조적 타이핑을 활용하여 필요한 메서드와 속성만 별도로 작성하자라고 느껴졌다.

Buffer 예시

Buffer 타입을 예시로 살펴보자. Buffer는 노드 개발자를 위한 것이다. Buffer 타입을 불러오기 위해 @types/node(NodeJS 타입 선언) 모듈을 설치해야 한다. 이를 설치하게 된다면 다음과 같은 개발자에게 문제가 생긴다.

 

1. 자바스크립트 개발자: NodeJS, @types와 무관하다.

2. 타입스크립트 개발자: NodeJS와 무관하다.

 

즉, 각자가 사용하지 않는 모듈이 포함되어 있기 때문에 혼란스러울 것이다. Buffer는 NodeJS 개발자에게만 필요하고 @types/node는 NodeJS와 타입스크립트를 동시에 사용하는 개발자만 관련된다.

미러링 사용하기

작성 중인 라이브러리가 의존하는 어떤 라이브러리의 구현과 무관하게 타입에만 의존한다면, 필요한 선언부만 추출하여 작성 중인 라이브러리에 넣는 것(미러링)을 고려해 보는 것이 좋다.

 

즉, Buffer가 어떻게 구현이 되었는지가 중요한 것이 아니라, Buffer의 타입이 필요한 상황에서 @types/node을 설치하지 않고 Buffer의 타입 중 필요한 메서드, 속성만 떼어 내어 명시할 수 있다.

// Buffer 타입에서 실제로 필요한 부분만을 떼어 내어 명시
type CsvBuffer = {
  toString(encoding: string): string;
};

function parseCSV(contents: string | CsvBuffer): { [column: string]: string } {
  if (typeof contents === 'object') {
    // 버퍼인 경우
    return parseCSV(contents.toString('utf8'));
  }
  // ...
  return {
    subject: 'abc',
  };
}

parseCSV 함수의 경우 매개변수 contents가 Buffer인 경우 Buffer 객체가 가지고 있는 toString 메서드가 필요하다. 그 외의 다른 메서드나 속성은 필요 없다. 때문에 CsvBuffer 타입을 살펴보면 다른 것은 없고 toString 메서드의 타입만 명시되어 있다. 

 

단지, Buffer의 toString 메서드의 타입만 가져오기 위해 @types/node 를 설치하지 말자.

 

하지만 다른 라이브러리의 타입 선언의 대부분을 추출해야 한다면, 차라리 명시적으로 @types 의존성을 추가하는 것이 좋다.

요약

1. 필수가 아닌 의존성을 분리할 때는 구조적 타이핑을 사용하자.

2. 공개한 라이브러리는 자바스크립트 개발자가 사용할 수 있으므로 @types 의존성을 가지지 않도록 해야 한다.

3. 공개한 라이브러리는 웹 개발자가 사용할 수 있으므로 NodeJS 관련된 의존성을 가지지 않게 해야 한다.