History

Björn b963b3396c init		4 years ago
..
CHANGELOG.md	init	4 years ago
CONTRIBUTORS.md	init	4 years ago
LICENSE.md	init	4 years ago
README.md	init	4 years ago
UPGRADING.md	init	4 years ago
example.js	init	4 years ago
index.js	init	4 years ago
package.json	init	4 years ago
test.js	init	4 years ago

README.md

level-iterator-stream

Turn an abstract-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.

Contributing

Level/iterator-stream is an OPEN Open Source Project. This means that:

Individuals making significant and valuable contributions are given commit-access to the project to contribute as they see fit. This project is more like an open wiki than a standard guarded open source project.

See the Contribution Guide for more details.

Donate

To sustain Level and its activities, become a backer or sponsor on Open Collective. Your logo or avatar will be displayed on our 28+ GitHub repositories and npm packages. 💖