hypercore-byte-stream

WebJar for hypercore-byte-stream

License	MIT
GroupId	org.webjars.npm
ArtifactId	hypercore-byte-stream
Last Version	1.0.4
Release Date	Jul 17, 2019
Type	jar
Description	hypercore-byte-stream WebJar for hypercore-byte-stream
Project URL	http://webjars.org
Source Code Management	https://github.com/andrewosh/hypercore-byte-stream

Download hypercore-byte-stream

Filename	Size
hypercore-byte-stream-1.0.4.pom
hypercore-byte-stream-1.0.4.jar	8 KB
hypercore-byte-stream-1.0.4-sources.jar	22 bytes
hypercore-byte-stream-1.0.4-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.npm/hypercore-byte-stream/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>hypercore-byte-stream</artifactId>
    <version>1.0.4</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/hypercore-byte-stream/
implementation 'org.webjars.npm:hypercore-byte-stream:1.0.4'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.npm/hypercore-byte-stream/
implementation ("org.webjars.npm:hypercore-byte-stream:1.0.4")

Apache Buildr

'org.webjars.npm:hypercore-byte-stream:jar:1.0.4'

Apache Ivy

<dependency org="org.webjars.npm" name="hypercore-byte-stream" rev="1.0.4">
  <artifact name="hypercore-byte-stream" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.npm', module='hypercore-byte-stream', version='1.0.4')
)

Scala SBT

libraryDependencies += "org.webjars.npm" % "hypercore-byte-stream" % "1.0.4"

Leiningen

[org.webjars.npm/hypercore-byte-stream "1.0.4"]

Dependencies

compile (1)

Group / Artifact	Type	Version
org.webjars.npm : readable-stream	jar	[3.1.1,4)

Project Modules

There are no modules declared in this project.

hypercore-byte-stream

A Readable stream wrapper around Hypercore that supports reading byte ranges.

When provided with optional start/end block heuristics, this module will efficiently sync only those blocks which contain the specified range.

Supports asynchronously specifying stream options, as well as the input feed, to remove the need for additional stream management modules like duplexify.

Most of the code has been extracted from Hyperdrive.

Usage

The following example will return a byte stream of the entire input feed.

const ram = require('random-access-memory')
const hypercore = require('hypercore')
const createByteStream = require('hypercore-byte-stream')

let core = hypercore(ram)
let stream = createByteStream({
  feed: core
})

API

stream = createStream([options])

Creates a new byte stream.

If specified, options can include:

{
  feed: core, // A hypercore.
  byteOffset: 0, // Starting offset in bytes from the start of the feed.
  byteLength: 10, // The number of bytes to read.
  blockOffset: 0, // An optional starting block heuristic (optimization).
  blockLength: 10 // An optional block length that should contain the entire range (optimization).
}

stream.start([options])

Starts downloading and streaming according to the specified options.

Options are the same as in createStream. If a feed was specified in the stream constructor, then one should not provide another stream in the start options.

License

MIT

Versions

Version
1.0.4 Jul 17, 2019