toml-stream

TOMLStream

Pipe an object stream into this and get a crisp, clear stream of TOML data. Because TOML is ultimately a key-value store, piping bare arrays into it makes no sense and will raise an error. At some point it may validate the input against a schema, but that's too fancy for now.

Fancy bonus feature: if you pass in a string instead of an object, the stream will emit that as a TOML comment.

usage

var TOMLStream = require('toml-stream')

var stream = new TOMLStream()
stream.pipe(process.stdout)
stream.end({key: 'value'})
// prints 'key = "value"' to stdout

require('toml-stream').toTOMLString

Convert a single object (or string, which will be turned into a TOML comment) into a TOML string.

usage

var toTOMLString = require('toml-stream').toTOMLString

toTOMLString({key: 'value'}, function (er, output) {
  if (er) throw er
  console.log(output)
})
// prints 'key = "value"' to stdout

note for developers

If you want to hack on this, you'll need to use npm@4 or newer, because this package relies on the new prepare lifecycle event.

MIT License

The MIT License (MIT)

Copyright (c) 2015 Forrest L Norvell [e-mail]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.