More than 3 years have passed since last update.

TypeScript型定義ファイルの置き場所

Last updated at 2021-05-22Posted at 2021-05-22

他にもやり方はあるようだが、一つの簡単なやり方。

外部に export する関数に対して

// src/main.ts
export function someFunc(a: number): string {
  return `Got ${a}`
}

index.d.ts に型定義を書いて、どこかに置く。例えば、src/index.d.ts

// src/index.d.ts
export function someFunc(a: number): string;

そして package.json の main に外部に export するファイルへのパス、typeings に型定義ファイルへのパスを指定する。

src/main.ts が dist/main.js にトランスパイルされるとするなら、

// package.json
{  
  "main": "dist/main.js", 
  ...
  "typings": "src/index.d.ts",
  ...
}