JSPM

  • Created
  • Published
  • Downloads 2488761
  • Score
    100M100P100Q234068F
  • License MIT

TOML parser for Node.js

Package Exports

  • toml

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (toml) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

TOML Parser for Node.js

Build Status

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

Instalation

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);

Streaming

You can pipe a stream of TOML text into toml-node and it will emit a single data event with the parsed results once the stream is complete.

var toml = require('toml');
var fs = require('fs');
fs.createReadStream('tomlFile.toml').pipe(toml.createStream()).on('data', function(results) {
  // `results` is your parsed TOML
});

The stream will emit an error event in the case of an error while parsing the TOML document.

TOML Spec Support

toml-node supports the TOML spec as specified by mojombo/toml@4a6ed394

Building & Tests

toml-node uses the Jison parser generator.

npm install -g jison
jison src/toml.jison -o lib/toml.js
npm test

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

  • Node 0.6
  • Node 0.8
  • Node 0.9

License

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