선언 파일(Declaration Files) 시작하기

선언 파일(Declaration Files) 시작하기

선언 파일(Declaration Files) 파트는 좋은 품질의 TypeScript 선언 파일(Declaration File)을 어떻게 쓰는지 가르쳐 주는 곳이에요. 시작하려면 TypeScript 언어 자체에 대한 기본적인 친숙함은 있다고 가정할게요. 아직 안 읽으셨다면 TypeScript Handbook을 먼저 훑어보시면 좋아요. 특히 타입(type)과 모듈(module) 개념이 중심이죠. 실제로 .d.ts 파일을 배우는 가장 흔한 경우는 타입이 없는 npm 패키지에 타입을 직접 붙여야 하는 상황이에요. 그런 분이라면 바로 Modules .d.ts로 건너뛰셔도 돼요.

출처: TypeScript 공식문서

본문

선언 파일 파트는 다음과 같은 섹션으로 나뉘어요.

Declaration Reference

우리는 자주 기반이 되는 라이브러리의 예시만 가지고 선언 파일을 써야 하는 상황에 부딪혀요. Declaration Reference 섹션은 흔한 API 패턴들과 각 패턴에 대한 선언을 어떻게 쓰는지 보여줘요. 아직 TypeScript의 모든 언어 요소에 익숙하지 않은 초보자를 대상으로 한 가이드예요.

Library Structures

Library Structures 가이드는 흔한 라이브러리 형식을 이해하고, 각 형식에 맞는 선언 파일을 제대로 쓰는 법을 도와줘요. 이미 있는 파일을 수정하는 중이라면 이 섹션은 굳이 안 읽어도 돼요. 반면 새 선언 파일을 작성하는 분이라면 꼭 읽어보시기를 권할게요. 라이브러리의 형식이 선언 파일 작성에 어떤 영향을 주는지를 제대로 이해해야 하거든요. Template 섹션에는 새 파일을 쓸 때 출발점으로 삼기 좋은 선언 파일이 여러 개 마련돼 있어요. 어떤 구조를 쓸지 이미 알고 있다면 사이드바에 있는 d.ts Template 섹션을 확인해 보세요.

Do's and Don'ts

선언 파일에서 저지르기 쉬운 실수는 대부분 충분히 피할 수 있어요. Do's and Don'ts 섹션은 흔한 오류가 무엇인지 짚어주고, 어떻게 발견하고 어떻게 고치는지 설명해요. 모두가 한 번씩 읽어서 흔한 실수를 피하시길 바라요.

Deep Dive

선언 파일이 내부적으로 어떻게 동작하는지 깊이 알고 싶은 숙련된 작성자라면, Deep Dive 섹션이 선언 작성의 고급 개념을 많이 설명해 줘요. 게다가 이 개념들을 활용해 더 깔끔하고 직관적인 선언 파일을 만드는 방법도 보여주죠.

Publish to npm

Publishing 섹션은 선언 파일을 npm 패키지로 배포하는 방법과, 의존하는 패키지를 관리하는 방법을 알려줘요.

Find and Install Declaration Files

JavaScript 라이브러리를 쓰는 분이라면, Consumption 섹션이 알맞은 선언 파일을 찾아 설치하는 몇 가지 간단한 절차를 안내해 줘요.

더 알아보기