jarle/Bun Import a JSON5 file

Import a JSON5 file

Bun natively supports .json5 imports.

{
  // Comments are allowed
  database: {
    host: "localhost",
    port: 5432,
    name: "myapp",
  },

  server: {
    port: 3000,
    timeout: 30,
  },

  features: {
    auth: true,
    rateLimit: true,
  },
}

Import the file like any other source file.

import config from "./config.json5";

config.database.host; // => "localhost"
config.server.port; // => 3000
config.features.auth; // => true

You can also use named imports to destructure top-level properties:

import { database, server, features } from "./config.json5";

console.log(database.name); // => "myapp"
console.log(server.timeout); // => 30
console.log(features.rateLimit); // => true

For parsing JSON5 strings at runtime, use Bun.JSON5.parse():

const data = JSON5.parse(`{
  name: 'John Doe',
  age: 30,
  hobbies: [
    'reading',
    'coding',
  ],
}`);

console.log(data.name); // => "John Doe"
console.log(data.hobbies); // => ["reading", "coding"]

See Docs > API > JSON5 for complete documentation on JSON5 support in Bun.