Package detail

level-iterator-stream

Level5.2mMIT5.0.0

Turn an abstract-leveldown iterator into a readable stream

level

readme

level-iterator-stream

Turn an abstract-leveldown iterator into a readable stream.

level badge npm Node version Travis Coverage Status JavaScript Style Guide npm Backers on Open Collective Sponsors on Open Collective

Usage

If you are upgrading: please see UPGRADING.md.

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

const db = leveldown(__dirname + '/db')

db.open(function (err) {
  if (err) throw err

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

Install

With npm do:

npm install level-iterator-stream

API

stream = iteratorStream(iterator[, options])

Create a readable stream from iterator. The 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 keys or values. Otherwise receive { key, value } objects.

Upon stream end or .destroy() the iterator will be closed after which a close event is emitted on the stream.

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. 💖

Backers

Open Collective backers

Sponsors

Open Collective sponsors

License

MIT © 2012-present Contributors.

changelog

Changelog

If you are upgrading: please see UPGRADING.md.

5.0.0 - 2021-04-09

Changed

4.0.2 - 2019-10-05

Changed

Added

4.0.1 - 2019-03-30

Changed

Fixed

4.0.0 - 2018-12-17

Changed

  • Upgrade through2 devDependency from ^2.0.0 to ^3.0.0 (@vweevers)
  • Upgrade readable-stream dependency from ^2.0.5 to ^3.0.2 (@ralphtheninja)
  • Upgrade standard devDependency from ^11.0.0 to ^12.0.0 (@ralphtheninja)

Added

Removed

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)

3.0.0 - 2018-06-28

Changed

Removed

2.0.3 - 2018-06-28

Fixed

Historical Note The previous release was meant to restore node 4 and included an additional change by mistake.

2.0.2 - 2018-06-28

Changed

Historical Note We made a mistake releasing v2.0.1 with the engines field in package.json set to node 6 as minimal version. This caused problems for users of yarn. We therefore released v2.0.2 which restored node 4 and a new major directly after this.

2.0.1 - 2018-06-10

Changed

  • Upgrade leveldown devDependency from ^1.4.1 to ^4.0.0 (@ralphtheninja)
  • Upgrade standard devDependency from ^10.0.3 to ^11.0.0 (@ralphtheninja)

Added

Removed

2.0.0 - 2017-08-28

Changed

Added

Removed

1.3.1 - 2015-08-17

Changed

  • Update .repository path in package.json (@timoxley)

Fixed

1.3.0 - 2015-05-05

Fixed

1.2.0 - 2015-05-04

Added

  • Add .decoder option to constructor for decoding keys and values (@juliangruber)

1.1.1 - 2015-03-29

Added

Fixed

1.1.0 - 2015-03-29

Added

1.0.0 - 2015-03-29

:seedling: Initial release.