hypercore 10.7.0 → 10.8.0

package/README.md

@@ -145,7 +145,7 @@ console.log('core was updated?', updated, 'length is', core.length)
 
 Use `core.findingPeers()` or `{ wait: true }` to make `await core.update()` blocking.
 
-#### `const [index, relativeOffset] = await core.seek(byteOffset)`
+#### `const [index, relativeOffset] = await core.seek(byteOffset, [options])`
 
 Seek to a byte offset.
 
@@ -160,6 +160,13 @@ const second = await core.seek(3) // returns [1, 0]
 const third = await core.seek(5) // returns [2, 1]
 ```
 
+``` js
+{
+  wait: true, // wait for data to be downloaded
+  timeout: 0 // wait at max some milliseconds (0 means no timeout)
+}
+```
+
 #### `const stream = core.createReadStream([options])`
 
 Make a read stream to read a range of data out at once.
@@ -292,7 +299,7 @@ Fully close this core.
 
 #### `core.on('close')`
 
-Emitted when then core has been fully closed.
+Emitted when the core has been fully closed.
 
 #### `await core.ready()`
 

package/index.js

@@ -649,7 +649,7 @@ module.exports = class Hypercore extends EventEmitter {
       return this._updateSnapshot()
     }
 
-    const remoteWait = typeof (opts && opts.wait) === 'boolean' ? opts.wait : this.replicator.findingPeers > 0
+    const remoteWait = this._shouldWait(opts, this.replicator.findingPeers > 0)
 
     let upgraded = false
 
@@ -679,9 +679,14 @@ module.exports = class Hypercore extends EventEmitter {
 
     if (this.closing !== null) throw SESSION_CLOSED()
 
+    if (!this._shouldWait(opts, this.wait)) return null
+
     const activeRequests = (opts && opts.activeRequests) || this.activeRequests
     const req = this.replicator.addSeek(activeRequests, s)
 
+    const timeout = opts && opts.timeout !== undefined ? opts.timeout : this.timeout
+    if (timeout) req.context.setTimeout(req, timeout)
+
     return req.promise
   }
 
@@ -741,8 +746,8 @@ module.exports = class Hypercore extends EventEmitter {
 
       if (this.cache) this.cache.set(index, block)
     } else {
-      if (opts && opts.wait === false) return null
-      if (this.wait === false && (!opts || !opts.wait)) return null
+      if (!this._shouldWait(opts, this.wait)) return null
+
       if (opts && opts.onwait) opts.onwait(index, this)
       if (this.onwait) this.onwait(index, this)
 
@@ -769,6 +774,14 @@ module.exports = class Hypercore extends EventEmitter {
     return block
   }
 
+  _shouldWait (opts, defaultValue) {
+    if (opts) {
+      if (opts.wait === false) return false
+      if (opts.wait === true) return true
+    }
+    return defaultValue
+  }
+
   createReadStream (opts) {
     return new ReadStream(this, opts)
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hypercore",
-  "version": "10.7.0",
+  "version": "10.8.0",
   "description": "Hypercore is a secure, distributed append-only log",
   "main": "index.js",
   "scripts": {