🐷

JSONファイルに型をつけたい

2021/10/11に公開

TypeScriptでJSONファイルをimportしたときに型がanyになりエラーになることがあるので,それを解決するための設定方法を記録

ts.config.jsonの設定を確認

以下のようになっていることを確認します.たぶんデフォルトでなっているはずです.

{
  "compilerOptions": {
    "moduleResolution": "node",
    "resolveJsonModule": true
  }
}

型宣言ファイルを作成

どこでもいいので,hoge.d.tsというファイルを作成します.

typesフォルダにjson.d.tsとかにして保存しておくと良いでしょう.中身は以下のようにします.

declare module '*/**.json' { // 指定したいJSONファイルのpath
  type JSONType {
    // 指定したい型
  }

  const value: JSONType;
  export = value;
}

これで指定したJSONファイルをimportしたさいのエラーが消えているでしょう✨

Discussion