toml

What is toml?

The 'toml' npm package is a library for parsing and stringifying TOML (Tom's Obvious, Minimal Language) data. TOML is a configuration file format that is easy to read due to its simplicity and human-readable syntax. This package allows you to convert TOML data to JavaScript objects and vice versa.

What are toml's main functionalities?

Parsing TOML to JavaScript Object

This feature allows you to parse a TOML string into a JavaScript object. The example demonstrates parsing a TOML string containing an 'owner' table with 'name' and 'dob' fields.

const toml = require('toml');
const tomlString = `
[owner]
name = "Tom Preston-Werner"
dob = 1979-05-27T07:32:00Z
`;
const parsedData = toml.parse(tomlString);
console.log(parsedData);

Stringifying JavaScript Object to TOML

This feature allows you to convert a JavaScript object into a TOML string. The example demonstrates stringifying a JavaScript object with an 'owner' property into a TOML formatted string.

const toml = require('toml');
const jsObject = {
  owner: {
    name: "Tom Preston-Werner",
    dob: new Date('1979-05-27T07:32:00Z')
  }
};
const tomlString = toml.stringify(jsObject);
console.log(tomlString);

Other packages similar to toml

toml-js

The 'toml-js' package is another library for parsing and stringifying TOML data. It offers similar functionality to the 'toml' package but may have different performance characteristics and API design.

tomlify-j0.4

The 'tomlify-j0.4' package focuses on converting JavaScript objects to TOML strings. It is useful if you primarily need to generate TOML data from JavaScript objects.

toml-node

The 'toml-node' package provides TOML parsing and stringifying capabilities. It is another alternative to the 'toml' package with its own implementation and features.

README

TOML Parser for Node.js

If you haven't heard of TOML, well you're just missing out. Go check it out now. Back? Good.

TOML Spec Support

toml-node supports version 0.2.0 the TOML spec as specified by mojombo/toml@v0.2.0

Installation

toml-node is available via npm.

npm install toml

Usage

Standalone

Say you have some awesome TOML in a variable called someTomlString. Maybe it came from the web; maybe it came from a file; wherever it came from, it came asynchronously! Let's turn that sucker into a JavaScript object.

var toml = require('toml');
var data = toml.parse(someTomlString);
console.dir(data);

toml.parse throws an exception in the case of a parsing error; such exceptions have a line and column property on them to help identify the offending text.

try {
  toml.parse(someCrazyKnuckleHeadedTrblToml);
} catch (e) {
  console.error("Parsing error on line " + e.line + ", column " + e.column +
    ": " + e.message);
}

Streaming

As of toml-node version 1.0, the streaming interface has been removed. Instead, use a module like concat-stream:

var toml = require('toml');
var concat = require('concat-stream');
var fs = require('fs');

fs.createReadStream('tomlFile.toml', 'utf8').pipe(concat(function(data) {
  var parsed = toml.parse(data);
}));

Thanks @ForbesLindesay for the suggestion.

Requiring with Node.js

You can use the toml-require package to require() your .toml files with Node.js

Live Demo

You can experiment with TOML online at http://binarymuse.github.io/toml-node/, which uses the latest version of this library.

Building & Testing

toml-node uses the PEG.js parser generator.

npm install
./generate.sh
npm test

Any changes to src/toml.peg requires a regeneration of the parser with ./generate.sh.

toml-node is tested on Travis CI and is tested against:

• Node 0.6
• Node 0.8
• Node 0.10
• Node 0.11

License

toml-node is licensed under the MIT license agreement. See the LICENSE file for more information.