https://github.com/geut/hyperbee-live-stream

Creates a ReadableStream but keep watching for changes in the range defined
https://github.com/geut/hyperbee-live-stream

hyperbee hypercore live stream streamx

Last synced: 4 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/geut/hyperbee-live-stream
• Owner: geut
• License: mit
• Created: 2021-01-27T11:17:21.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2022-06-21T12:31:52.000Z (over 3 years ago)
• Last Synced: 2025-04-18T16:17:18.611Z (11 months ago)
• Topics: hyperbee, hypercore, live, stream, streamx
• Language: JavaScript
• Homepage:
• Size: 771 KB
• Stars: 16
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# hyperbee-live-stream

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

[![Build Status](https://travis-ci.com/geut/hyperbee-live-stream.svg?branch=main)](https://travis-ci.com/geut/hyperbee-live-stream)

[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)

[![Made by GEUT][geut-badge]][geut-url]

## Install

    $ npm install @geut/hyperbee-live-stream

## Usage

```js

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

:bug: If you found an issue we encourage you to report it on [github](https://github.com/geut/hyperbee-live-stream/issues). 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](https://github.com/geut/hyperbee-live-stream/blob/main/CONTRIBUTING.md).

## License

MIT © A [**GEUT**](http://geutstudio.com/) project

[geut-url]: https://geutstudio.com

[geut-badge]: https://img.shields.io/badge/Made%20By-GEUT-4f5186?style=for-the-badge&link=https://geutstudio.com&labelColor=white&logo=data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDABALDA4MChAODQ4SERATGCgaGBYWGDEjJR0oOjM9PDkzODdASFxOQERXRTc4UG1RV19iZ2hnPk1xeXBkeFxlZ2P/2wBDARESEhgVGC8aGi9jQjhCY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2NjY2P/wAARCABAAEADASIAAhEBAxEB/8QAGwAAAgIDAQAAAAAAAAAAAAAABAYDBQACBwH/xAA0EAACAQMBBAcGBgMAAAAAAAABAgMABBEFBhIhQRMiMVFhgcEUIzJxkbFCUmKh0fAkcuH/xAAYAQADAQEAAAAAAAAAAAAAAAABAwQCAP/EACARAAMAAwACAgMAAAAAAAAAAAABAgMRIRIxBEEiM1H/2gAMAwEAAhEDEQA/AOgVlau6xoXdgqqMkk8AKV9U2oYs0WngBRw6VhxPyFamXXoDeiz1PUbmzuujQIUKgjIqGLXnz72FSO9TikfVbi6uXWSSaWRuzixNBx3VzCepNIvgTw+hpjwv+iGr3tM6xa30F2PdP1uangRRNc70fUbi4JLIVaPskXgM/wA076Ze+2W+WwJF4MPWlNaemajI2/GvYbWVlZQHCptZqLNKLGJsKoDSY5nkKorKzlvrlYIRlm5nsA7zWX8pnv55SfikJ/emPZGDcs7m6CguTuL5DPrVf64Me2F2mzNhAg6ZTO/MsSB9BW15s1pt1GVEPRHvQ+hqbTNT9sZ0kCpIOIA5ij5ZEijaSRgqqMkmpVkb7sMuWtoV73S49L3I4B7kjq57c881BZ6vFpuoKjq7dIvYBw8PtUOqX1xcSxoJXw8mQuewVW3vX1eFR+Fcn96OLVvpFzz8kM020kp4QwIvixzVpot5Je2bSTEFw5HAY7qUKadnIymm7x/G5I+3pTskzM8G4rqq6JGpI8E1wi8HR2H0NT7P6rcRKUEzYR9/czgEf0VabV2JgvhdKPdzdvg399aVG37K4Esfw/3hTU1S2NpNrSHqax9q/wAzTm3lY5KA4ZTQl2mo9CWljncL+cnA+tVVhqeSGt5mik5qDg/9o+XVb6aFonuDusMHqjP2qavjbfGTPX3xgTstrm4uGDSEYVV+woWPMKy3dzwd+JHcOQrdkgtyZpXJb87nJ8qqr68a7cKgIjB4DmadGNQjohs9i1C66Xqtvbx+EjIp10jaOMLBaPasDwRTGc5PyNJ1rb9EN5/jP7U17KaaZJvbpV6icI88z3+VG0vH8ipJJ8Ga8tIr22eCYZVh5g94pC1TTJtPmMU67yH4XxwYV0So54IriIxzRrIh7QwzSIyOTbWzlElkCcxtjwNedHeKMCVseDmnq72UgkJa1maL9LDeH81XvspfA9WSBh/sR6U9XD+zDQp+yTSNmR/MnJomG3SLiBlu80zQ7JXTH31xEg/Tlj6Vb2OzljaEO6meQc5OweVc8koOmUGjaFLfuss4MdsOOewv8v5p0ijSGNY41CoowAOQrbsr2p7t0zSWj//Z