zeronet-node v0.0.8

ZeroNet Node

ZeroNet full node

API

API for index.js

Class ZeroNetNode

Constructor - new node.ZeroNetNode(options)

ZeroNet full-node

• options: Must be an object

ZeroNetNode.logger(prefix)

Creates a logger

• prefix: Must be a string

ZeroNetNode.start(callback)

Starts the node

callback is a function that will be called after the operation finishes with the following argument(s), if applicable: err: the resulting error

ZeroNetNode.boot(callback)

Loads the config from disk (already done by start)

callback is a function that will be called after the operation finishes with the following argument(s), if applicable: err: the resulting error

ZeroNetNode.save(callback)

Saves the config to disk

callback is a function that will be called after the operation finishes with the following argument(s), if applicable: err: the resulting error

ZeroNetNode.stop(callback)

Stops the node

callback is a function that will be called after the operation finishes with the following argument(s), if applicable: err: the resulting error

This module uses pull-streams

We expose a streaming interface based on pull-streams, rather then on the Node.js core streams implementation (aka Node.js streams). pull-streams offers us a better mechanism for error handling and flow control guarantees.

You can learn more about pull-streams at:

• The history of Node.js streams, nodebp April 2014
• The history of streams, 2016
• pull-streams, the simple streaming primitive
• pull-streams documentation

Converting pull-streams to Node.js Streams

If you are a Node.js streams user, you can convert a pull-stream to a Node.js stream using the module pull-stream-to-stream, giving you an instance of a Node.js stream that is linked to the pull-stream. For example:

const pullToStream = require('pull-stream-to-stream')

const nodeStreamInstance = pullToStream(pullStreamInstance)
// nodeStreamInstance is an instance of a Node.js Stream

To learn more about this utility, visit https://pull-stream.github.io/#pull-stream-to-stream.

ZeroNetJS is developed independently from ZeroNet

Docs are autogenerated by a script