js-toml

A TOML parser for JavaScript and TypeScript. Fully tested and 100% compatible with the TOML v1.0.0 spec. Support Node.js, browsers and Bun⚡️!

---

Trusted By

js-toml is trusted in production by teams at leading companies and major open-source projects, including:

• Microsoft (in pyright)
• AWS (Amazon Web Services) (in aws-lambda-rust-runtime)
• Mise (a next-gen asdf)
• Open edX (in over 28 packages)
• LINE (in abc-user-feedback)
• MongoDB (in the snooty documentation compiler)
• ... and many more.

---

Installation

npm install js-toml

or with yarn

yarn add js-toml

or with pnpm

pnpm add js-toml

even support bun!

bun add js-toml

Usage

import {load} from 'js-toml';

const toml = `
title = "TOML Example"

[owner]
name = "Tom Preston-Werner"
dob = 1979-05-27T07:32:00-08:00 # First class dates
`;

const data = load(toml);
console.log(data);

API

load(toml: string): object

Parses a TOML string and returns a JavaScript object.

dump(object: object): string

Under development.

License

MIT

References

TOML v1.0.0 Official Specs

TOML GitHub Project

TOML Test

iarna-toml