# zeronet-zite

> ZeroNet Zite Class

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

## Install

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

## 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.7 |
| Published | 2018-02-25 |
| First published | 2017-06-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 13 |
| Unpacked size | 50.6 KB |
| Known vulnerabilities | 0 (+2 in 2 direct dependencies) |
| Install scripts | no |
| Author | Maciej Krüger |
| Maintainers | mkg20001 |
| Keywords | zeronet, zite |

## Links

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

## Dependencies (13)

- [ip](https://npm.io/package/ip.md) ^1.1.5
- [uuid](https://npm.io/package/uuid.md) ^3.2.1
- [async](https://npm.io/package/async.md) ^2.6.0
- [peer-info](https://npm.io/package/peer-info.md) ~0.11.6
- [hypercache](https://npm.io/package/hypercache.md) ~0.2.0
- [pull-cache](https://npm.io/package/pull-cache.md) 0.0.0
- [pull-defer](https://npm.io/package/pull-defer.md) ~0.2.2
- [pull-queue](https://npm.io/package/pull-queue.md) ~0.1.4
- [pull-stream](https://npm.io/package/pull-stream.md) ^3.6.2
- [pull-paramap](https://npm.io/package/pull-paramap.md) ^1.2.2
- [zeronet-common](https://npm.io/package/zeronet-common.md) ~0.3.0
- [zeronet-crypto](https://npm.io/package/zeronet-crypto.md) ~0.2.1
- [zeronet-fallaby](https://npm.io/package/zeronet-fallaby.md) 0.0.2

## Recent versions

- 0.0.7 (latest) — 2018-02-25
- 0.0.6 — 2018-02-25
- 0.0.5 — 2017-12-27
- 0.0.4 — 2017-11-25
- 0.0.3 — 2017-11-25
- 0.0.2 — 2017-11-25
- 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-alpha13 — 2017-07-13
- 0.0.1-alpha12 — 2017-07-07
- 0.0.1-alpha10 — 2017-06-25
- … 4 more at https://npm.io/package/zeronet-zite/versions

## README

# ZeroNet Zite

ZeroNet Zite class

# API

## API for content-json.js

### Class ContentJSON

#### Constructor - `new json.ContentJSON(zite, inner_path, data, rules)`

 > Zite content.json

 - zite: Must be a Zite
 - inner_path: Path of the content.json
 - data: JSON parsed data of the content.json
 - rules: RuleBook containing the rules for the zite

#### `ContentJSON.verifySelf( /* seems like that's not documented yet */ )`

#### `ContentJSON.verifyFile( /* seems like that's not documented yet */ )`

#### `ContentJSON.createRuleBook( /* seems like that's not documented yet */ )`

## API for index.js

### Class Zite

#### Constructor - `new zite.Zite(config, zeronet)`

 > ZeroNet Zite

 - config: configuration of the Zite
 - zeronet: ZeroNet Node

#### `Zite.handleGet( /* seems like that's not documented yet */ )`

#### `Zite.start( /* seems like that's not documented yet */ )`

#### `Zite.stop( /* seems like that's not documented yet */ )`

#### `Zite.toJSON()`

 > Converts the site to json

## API for pool.js

### Class ZitePeerPool

#### Constructor - `new pool.ZitePeerPool(zite, zeronet)`

 > ZeroNet Zite peer pool

 - zite: The zite
 - zeronet: Global zeronet object

#### `ZitePeerPool.getAll( /* seems like that's not documented yet */ )`

#### `ZitePeerPool.getConnected( /* seems like that's not documented yet */ )`

#### `ZitePeerPool.getUnconnected( /* seems like that's not documented yet */ )`

#### `ZitePeerPool.dialMany( /* seems like that's not documented yet */ )`

#### `ZitePeerPool.getMany( /* seems like that's not documented yet */ )`

#### `ZitePeerPool.getUntil( /* seems like that's not documented yet */ )`

#### `ZitePeerPool.next( /* seems like that's not documented yet */ )`

## API for rulebook.js

### Class RuleBook

#### Constructor - `new rulebook.RuleBook()`

 > A rule book defines which and how many keys can/have to sign

#### `RuleBook.isKeyAllowed( /* seems like that's not documented yet */ )`

#### `RuleBook.getSignersRequired( /* seems like that's not documented yet */ )`

#### `RuleBook.getValidKeys( /* seems like that's not documented yet */ )`

#### `RuleBook.verifySignature( /* seems like that's not documented yet */ )`

#### `RuleBook.createSubBook( /* seems like that's not documented yet */ )`

## API for tree.js

### Class FileTreeObject

#### `FileTreeObject.consturctor( /* seems like that's not documented yet */ )`

#### `FileTreeObject.exists( /* seems like that's not documented yet */ )`

#### `FileTreeObject.get( /* seems like that's not documented yet */ )`

#### `FileTreeObject.updateTree( /* seems like that's not documented yet */ )`

### Class FileTreeLeafObject

### Class FileTreeLeafObject

#### `FileTreeLeafObject.exists( /* seems like that's not documented yet */ )`

#### `FileTreeLeafObject.get( /* seems like that's not documented yet */ )`

### Class FileTreeRoot

### Class FileTreeRoot

#### `FileTreeRoot.setMainBranch( /* seems like that's not documented yet */ )`

#### `FileTreeRoot.getRuleBook( /* seems like that's not documented yet */ )`

### Class ContentJSONBranch

### Class ContentJSONBranch

#### `ContentJSONBranch.verify( /* seems like that's not documented yet */ )`

### Class FileBranch

### Class FileBranch

-----

[ZeroNetJS](github.com/ZeroNetJS) is developed independently from [ZeroNet](github.com/HelloZeroNet)

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

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