@geut/hyperbee-live-stream

    1.0.6 • Public • Published

    hyperbee-live-stream

    Creates a ReadableStream but keep watching for changes in the range defined.

    Build Status JavaScript Style Guide standard-readme compliant

    Made by GEUT

    Install

    $ npm install @geut/hyperbee-live-stream
    

    Usage

    const { HyperbeeLiveStream } = require('@geut/hyperbee-live-stream')
    
    const stream = new HyperbeeLiveStream(db, { gte: 'a', lte: 'b' })
    stream.on('data', data => console.log(data))
    db.put('a')
    db.put('c')
    db.put('b')
    // will print a, b

    API

    hyperbeeLiveStream = new HyperbeeLiveStream(db, opts?)

    • db: Hyperbee
    • opts?: any = {}
      • old?: boolean = true Iterate over the old items before start to watching
      • gt?: Buffer | string Only return keys > than this
      • gte?: Buffer | string Only return keys >= than this
      • lt?: Buffer | string Only return keys < than this
      • lte?: Buffer | string Only return keys <= than this
      • reverse?: boolean = false Set to true to get them in reverse order
      • limit?: number = -1 Set to the max number of entries you want

    hyperbeeLiveStream.version: number (R)

    Returns the last matched version readed

    hyperbeeLiveStream.on('synced', version) => void

    Emitted when the stream is synced with the last version in the database

    • version: number

    Issues

    🐛 If you found an issue we encourage you to report it on github. Please specify your OS and the actions to reproduce it.

    Contributing

    👥 Ideas and contributions to the project are welcome. You must follow this guideline.

    License

    MIT © A GEUT project

    Install

    npm i @geut/hyperbee-live-stream

    DownloadsWeekly Downloads

    147

    Version

    1.0.6

    License

    MIT

    Unpacked Size

    11 kB

    Total Files

    5

    Last publish

    Collaborators

    • geutuser
    • elmasse
    • the-real-dk
    • tinchoz49
    • estebanprimost