Creating typescript interface from JSON object

Question

Is there a way to import a JSON object into a Typescript program so that it is automatically strongly typed and constant?

So if I have this code in person.json:

{
  "name": "Steven",
  "eyeColor": "brown"
}

I want to be able to import it to a Typescript program as such:

// personTest.ts
const person = require('person.json');
console.log(person.name); // This should be fine
console.log(person.age);  // This should cause a compile-time error, because this property is not defined

have you tried using ESM ? import person from 'person.json' — Chemi Adel
– Chemi Adel, Commented Mar 18, 2022 at 21:45

Chemi Adel · Accepted Answer · 2022-03-19 04:09:43Z

3

add this on tsconfig.json

{

   ... //prev code

   "resolveJsonModule": true, 

}

then you can use ESM modules to import json file and it will be auto typed the object values

import person from './person.json' //be sure from the json path

edited Mar 19, 2022 at 4:09

answered Mar 18, 2022 at 21:54

Chemi Adel

2,1651 gold badge13 silver badges24 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

Creating typescript interface from JSON object

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related