@geut/hyperbee-live-stream
v1.0.7
Published
Hyperbee createReadStream live
Downloads
5
Readme
hyperbee-live-stream
Creates a ReadableStream but keep watching for changes in the range defined.
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 watchinggt?: Buffer | string
Only return keys > than thisgte?: Buffer | string
Only return keys >= than thislt?: Buffer | string
Only return keys < than thislte?: Buffer | string
Only return keys <= than thisreverse?: boolean = false
Set to true to get them in reverse orderlimit?: 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
:bug: If you found an issue we encourage you to report it on github. Please specify your OS and the actions to reproduce it.
Contributing
:busts_in_silhouette: Ideas and contributions to the project are welcome. You must follow this guideline.
License
MIT © A GEUT project