JSON Modules in JavaScript

ES Modules were introduced in ES2015. The import and export keywords by default are only applicable to JavaScript code. But there is a new proposal to allow it to be used for JSON modules in JavaScript.

It is convenient to keep some configuration inside a JSON file and import that. And this was possible using the commonjs module format. The proposal will allow us to do import JSON Modules in an ES module.

- Advertisement -

Let us assume we have a configuration file called configuration.js. The following will give an error by default:

import config from './configuration.json';

Node.js will throw the following error:

TypeError [ERR_UNKNOWN_FILE_EXTENSION]: Unknown file extension ".json"

JSON modules proposal

The proposal now allows us to import JSON modules using an import assertion.

import jsonObject from "./file.json" assert { type: "json" };

assert { type: “json” } is what is defined as an import assertion that specifies the type of the module and how it should be parsed and imported as.

The jsonObject variable will contain the JavaScript object obtained after parsing the file.

Note: named imports are not available for JSON modules.

It is also possible to import JSON modules dynamically.

const { default: jsonObject } = await import('./file.json', {
  assert: {
    type: 'json'
  }
});

Support

JSON modules currently work in Node.js >=17.1 by using the –experimental-json-modules flag.

node --experimental-json-modules index.mjs

For browsers, Chrome 91 already has support for JSON modules and others should implement it soon.

Recent Articles

Overriding nested dependencies in NPM

Whenever we install a particular package, it is common to come across a problem with a dependency's dependency. With the release of...

Automatic batching in React 18 helps avoid re-rendering

Remember the earlier versions of React that used to batch multiple state updates inside event handlers such as click or change to...

Flatten Arrays in Vanilla JavaScript with flat() and flatMap()

ES2019 introduced two methods on the array prototype that would make life so much simpler for developers. These are flat() and flatmap()...

Using GroupBy on an array of objects in JavaScript

Array grouping is a fairly common operation in any project. Until recently, we had to resort to either writing our own implementation...

Node.js introduces node: protocol imports

Node.js recently introduced a node: protocol for built-in modules. Built-in node modules can now be imported by prefixing the node: protocol prefix.

Related Stories

Leave A Reply

Please enter your comment!
Please enter your name here

Hi there! Want some more knowledge?

Think that the knowledge shared is helpful? You might want to give our mailing list a try. We'll send you 2-4 emails a month, right when new posts come out.

Hi there! Want some more knowledge?

Think that the knowledge shared is helpful? You might want to give our mailing list a try. We'll send you 2-4 emails a month, right when new posts come out.