write and consume d.ts

타입 선언 파일 작성 실전

타입 선언 파일 작성은 실제 JavaScript 모듈의 사용법을 TypeScript 시그니처로 옮겨 호출부 검사를 가능하게 만드는 작업입니다.

시나리오 파악

JS API 사용법 확인

유틸리티 함수가 어떤 인자를 받고 무엇을 반환하는지 실제 코드에서 먼저 확인합니다.

utils.js
모듈 선언

import 경로와 맞추기

declare module 안의 이름은 사용자가 가져오는 경로 문자열과 같아야 합니다.

declare module "./utils"
사용 확인

호출부 자동완성

선언 파일을 추가한 뒤 TypeScript 파일에서 타입 오류와 자동완성이 동작하는지 봅니다.

import { sum }
배포 기준

types 필드 연결

패키지로 배포할 때 package.json이 주 선언 파일을 가리키게 합니다.

"types": "index.d.ts"
전역 선언 전역 변수나 함수는 declare global로 범위를 분명히 합니다.
과한 any 처음부터 any로 덮지 말고 실제 입력과 반환을 가능한 만큼 좁힙니다.
검증 방식 예상 호출 예제와 잘못된 호출 예제를 둘 다 만들어 선언이 작동하는지 확인합니다.

선언 파일은 JavaScript 구현을 바꾸지 않고도 호출 가능한 함수, 객체, 모듈 경계를 TypeScript가 검사하게 합니다.