# zeronet-node

> ZeroNet full node

Latest version **0.0.8** (published 2018-02-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install zeronet-node
pnpm add zeronet-node
yarn add zeronet-node
bun add zeronet-node
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.8 |
| Published | 2018-02-25 |
| First published | 2017-07-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 9 |
| Unpacked size | 17.8 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Maciej Krüger |
| Maintainers | mkg20001 |
| Keywords | zeronet, node |

## Links

- npm: https://www.npmjs.com/package/zeronet-node
- Repository: https://github.com/ZeroNetJS/zeronet-node
- Homepage: https://github.com/ZeroNetJS/zeronet-node#readme
- Issues: https://github.com/ZeroNetJS/zeronet-node/issues
- npm.io page: https://npm.io/package/zeronet-node

## Dependencies (9)

- [uuid](https://npm.io/package/uuid.md) ^3.2.1
- [async](https://npm.io/package/async.md) ^2.6.0
- [clone](https://npm.io/package/clone.md) ^2.1.1
- [hypercache](https://npm.io/package/hypercache.md) ~0.2.0
- [zeronet-zite](https://npm.io/package/zeronet-zite.md) 0.0.7
- [zeronet-swarm](https://npm.io/package/zeronet-swarm.md) ~0.2.1
- [zeronet-common](https://npm.io/package/zeronet-common.md) ~0.3.0
- [zeronet-tracker](https://npm.io/package/zeronet-tracker.md) ~0.1.1-zn
- [zeronet-fileserver](https://npm.io/package/zeronet-fileserver.md) 0.0.8

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 0.0.8 (latest) — 2018-02-25
- 0.0.7 — 2018-02-25
- 0.0.6 — 2018-01-26
- 0.0.5 — 2018-01-26
- 0.0.4 — 2017-12-27
- 0.0.3 — 2017-12-23
- 0.0.2 — 2017-12-13
- 0.0.1 — 2017-11-25
- 0.0.1-alpha18 — 2017-09-10
- 0.0.1-alpha17 — 2017-08-10
- 0.0.1-alpha16 — 2017-08-10
- 0.0.1-alpha15 — 2017-07-22
- 0.0.1-alpha14 — 2017-07-22
- 0.0.1-alpha14pre — 2017-07-15

## README

# 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](https://www.youtube.com/watch?v=g5ewQEuXjsQ)
- [The history of streams, 2016](http://dominictarr.com/post/145135293917/history-of-streams)
- [pull-streams, the simple streaming primitive](http://dominictarr.com/post/149248845122/pull-streams-pull-streams-are-a-very-simple)
- [pull-streams documentation](https://pull-stream.github.io/)

#### 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`](https://github.com/pull-stream/pull-stream-to-stream), giving you an instance of a Node.js stream that is linked to the pull-stream. For example:

```js
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](https://github.com/ZeroNetJS) is developed independently from [ZeroNet](https://github.com/HelloZeroNet)

Docs are autogenerated by [a script](/docs-gen/lib/index.js?raw=true)

---
_Source: https://npm.io/package/zeronet-node · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._