hypercore 10.0.0-alpha.10 → 10.0.0-alpha.11

package/README.md

@@ -98,6 +98,19 @@ Truncate the core to a smaller length.
 Per default this will update the fork id of the core to `+ 1`, but you can set the fork id you prefer with the option.
 Note that the fork id should be monotonely incrementing.
 
+#### `const stream = core.createReadStream([options])`
+
+Make a read stream. Options include:
+
+``` js
+{
+  start: 0,
+  end: core.length,
+  live: false,
+  snapshot: true // auto set end to core.length on open or update it on every read
+}
+```
+
 #### `const range = core.download([range])`
 
 Download a range of data.

package/index.js

@@ -14,6 +14,7 @@ const Replicator = require('./lib/replicator')
 const Extensions = require('./lib/extensions')
 const Core = require('./lib/core')
 const BlockEncryption = require('./lib/block-encryption')
+const { ReadStream } = require('./lib/streams')
 
 const promises = Symbol.for('hypercore.promises')
 const inspect = Symbol.for('nodejs.util.inspect.custom')
@@ -400,6 +401,10 @@ module.exports = class Hypercore extends EventEmitter {
     return this._decode(encoding, block)
   }
 
+  createReadStream (opts) {
+    return new ReadStream(this, opts)
+  }
+
   download (range) {
     const linear = !!(range && range.linear)
 

package/lib/streams.js

@@ -0,0 +1,39 @@
+const { Readable } = require('streamx')
+
+class ReadStream extends Readable {
+  constructor (core, opts = {}) {
+    super()
+
+    this.core = core
+    this.start = opts.start || 0
+    this.end = typeof opts.end === 'number' ? opts.end : -1
+    this.snapshot = !opts.live && opts.snapshot !== false
+    this.live = !!opts.live
+  }
+
+  _open (cb) {
+    this._openP().then(cb, cb)
+  }
+
+  _read (cb) {
+    this._readP().then(cb, cb)
+  }
+
+  async _openP () {
+    if (this.end === -1) await this.core.update()
+    else await this.core.ready()
+    if (this.snapshot && this.end === -1) this.end = this.core.length
+  }
+
+  async _readP () {
+    const end = this.live ? -1 : (this.end === -1 ? this.core.length : this.end)
+    if (end >= 0 && this.start >= end) {
+      this.push(null)
+      return
+    }
+
+    this.push(await this.core.get(this.start++))
+  }
+}
+
+exports.ReadStream = ReadStream

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hypercore",
-  "version": "10.0.0-alpha.10",
+  "version": "10.0.0-alpha.11",
   "description": "Hypercore 10",
   "main": "index.js",
   "scripts": {

package/test/streams.js

@@ -0,0 +1,55 @@
+const test = require('brittle')
+
+const { create } = require('./helpers')
+
+test('basic read stream', async function (t) {
+  const core = await create()
+
+  const expected = [
+    'hello',
+    'world',
+    'verden',
+    'welt'
+  ]
+
+  await core.append(expected)
+
+  for await (const data of core.createReadStream()) {
+    t.alike(data.toString(), expected.shift())
+  }
+
+  t.is(expected.length, 0)
+})
+
+test('read stream with start / end', async function (t) {
+  const core = await create()
+
+  const datas = [
+    'hello',
+    'world',
+    'verden',
+    'welt'
+  ]
+
+  await core.append(datas)
+
+  {
+    const expected = datas.slice(1)
+
+    for await (const data of core.createReadStream({ start: 1 })) {
+      t.alike(data.toString(), expected.shift())
+    }
+
+    t.is(expected.length, 0)
+  }
+
+  {
+    const expected = datas.slice(2, 3)
+
+    for await (const data of core.createReadStream({ start: 2, end: 3 })) {
+      t.alike(data.toString(), expected.shift())
+    }
+
+    t.is(expected.length, 0)
+  }
+})