Skip to content

kenany/json2toml

Repository files navigation

json2toml

Convert JSON to TOML.

Example

const json2toml = require('json2toml');

json2toml({simple: true});
// => 'simple = true\n'

// Also supports pretty-printing options
json2toml(
  {
    deeply: {
      option: false,
      nested: {
        option: true
      }
    }
  },
  { indent: 2, newlineAfterSection: true }
);
// => [deeply]
// =>   option = false
// =>
// => [deeply.nested]
// =>   option = true

Installation

$ npm install json2toml

API

const json2toml = require('json2toml');

json2toml(hash, options = {})

Converts an Object hash to TOML, and returns the result as a String.

  • options.indent: Number of spaces for indentation.
  • options.newlineAfterSection: Whether or not to output a newline after the last pair in a hash if that hash wasn't empty.

Throws a TypeError if undefined, null, or a sparse array is encountered.