将 JSON 作为类型导入

Question

如何定义导入的 json 的类型？例如

{
  "things": "foo"
}

interface Data {
  things: String,
  another?: String
}

import data from './data.json' // Should have type Data
console.log(data.things)
console.log(data.another) // Should be allowed but undefined

该resolveJsonModule选项将自动为导入的 JSON 生成类型，但它是不完整的，因为 JSON 可能不包含数据的所有可能字段。

我自己如何定义类型？

Answer 1

我在这里可以想到3个主要方法：

1. 您可以将 arequire与类型断言一起使用，如下所示：

const data: Data = require('./data.json')

2. 您可以继续import，但使用附加变量（类型化），如下所示：

import untypedData from './data.json'

const data: Data = untypedData

3. 您可以添加一个模块类型文件并将其添加到typeRoots您的部分，tsconfig.json如下所示：

// File data.d.ts
declare module "data.json" {
  things: String,
  another?: String
}

// File tsconfig.json
{
  ...
  "typeRoots": [
    "/*path to data.d.ts*/"
  ]
}

这将使您import能够正确输入导入的项目

另请参阅 在 TypeScript 中导入 json 文件