Naughty Program Manipulator

    level-iterator-stream

    5.0.0 • Public • Published

    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.

    Keywords

    Install

    npm i level-iterator-stream

    DownloadsWeekly Downloads

    824,095

    Version

    5.0.0

    License

    MIT

    Unpacked Size

    17.9 kB

    Total Files

    7

    Last publish

    Collaborators

    • vweevers
    • juliangruber
    • ralphtheninja