開発覚書はてな版

個人的な開発関連の備忘録

【TypeScript】jsonファイルから型の抽出・生成

概要

  • TypeScript の resolveJsonModule オプションを使用することでJSONファイルから型の抽出・生成を行います。
  • TypeScript 2.9以降で使用できます。

www.typescriptlang.org

実行環境

  • Node.js - 10.x
  • Yarn - 1.17.x

使用ライブラリ

  • TypeScript - 3.7.x

サンプルソース

tsconfig.json

{
  "compilerOptions": {
    "target": "esnext",
    "module": "commonjs",
    "sourceMap": true,
    "outDir": "./dist",
    "esModuleInterop": true,
    "resolveJsonModule": true
  },
  "include": [
   "src/**/*"
  ]
}

src/data.json

{
  "id": 1,
  "memo": "hogehoge"
}

src/main.ts

import data from './data.json';

console.log(`id=${data.id}, memo=${data.memo}`);

実行結果

id=1, memo=hogehoge

サンプルソース一式

github.com