Giter VIP home page Giter VIP logo

zeronet-node's Introduction

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:

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

zeronet-node's People

Contributors

mkg20001 avatar

Watchers

James Cloos avatar Andrew Kidoo avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.