level-iterator-stream

level-iterator-stream

Turn a leveldown iterator into a readable stream

Usage

If you are upgrading: please see UPGRADING.md.

var iteratorStream = require('level-iterator-stream')
var leveldown = require('leveldown')

var db = leveldown(__dirname + '/db')
db.open(function (err) {
  if (err) throw err

  var stream = iteratorStream(db.iterator())
  stream.on('data', function (kv) {
    console.log('%s -> %s', kv.key, kv.value)
  })
})

Installation

$ npm install level-iterator-stream

API

stream = iteratorStream(iterator[, options])

Create a readable stream from iterator. options are passed down to the require('readable-stream').Readable constructor, with objectMode forced to true.

Set options.keys or options.values to false to only get values / keys. Otherwise receive { key, value } objects.

When the stream ends, the iterator will be closed and afterwards a "close" event emitted.

.destroy() will force close the underlying iterator.

License

Copyright © 2012-present level-iterator-stream contributors.

level-iterator-stream is licensed under the MIT license. All rights not explicitly granted in the MIT license are reserved. See the included LICENSE.md file for more details.

Changelog

[3.0.1] - 2018-10-18

Fixed

• Bump readable-stream from ^2.0 to ^2.3 to prevent npm dedupe and ensure it has #destroy() (@vweevers)