Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

js-toml

sunnyadn30.5kMIT1.0.2TypeScript support: included

A TOML parser for JavaScript/TypeScript, targeting TOML 1.0.0 Spec

toml, parser, javascript, typescript

readme

js-toml

codecov github actions License: MIT npm version

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⚡️!

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