0.2.0 • Published 8 years ago

hypercore-create-stream v0.2.0

Weekly downloads
-
License
MIT
Repository
-
Last release
8 years ago

hypercore-create-stream

Create a readable and/or writable stream of a hypercore feed.

npm install hypercore-create-stream

Usage

Create stream from a secret key

var createStream = require('hypercore-create-stream')
var signatures = require('sodium-signatures')

var keys = signatures.keyPair()
var stream = createStream(keys.secretKey)
stream.write('hello')
stream.once('data', function (block) {
  console.log(block.toString()) // hello
})

API

var stream = createStream([key], [options])

key is either a public or private key. If it is a public key, then the stream will be readable only. If it is a private key, then the stream will be both readable and writable. If it is undefined, then a new feed is made and its public and private keys are given by stream.key and stream.secretKey.

All options are optional.

{
  db: leveldb instance,
  static: boolean,
  storage: object,
  tail: boolean,
  start: integer,
  end: integer
}