aljaz/pear-docs
1
0
Fork 0
mirror of https://github.com/aljazceru/pear-docs.git synced 2025-12-17 06:24:24 +01:00
Code Issues Packages Projects Releases Wiki Activity

Doc updates for Pear release 1.6.0 (#155)

Browse Source 
* Add dump dry-run flag

Added to pear with https://github.com/holepunchto/pear/pull/400/files

* Add `pear sidecar` logging flags

`-v` & `--sidecar` weren't added as they aren't used.

* Add `Pear.config.dht.nodes` & `Pear.config.dht.bootstrap`
This commit is contained in:
Sean Zellmer
2024-11-14 16:24:33 -06:00
committed by GitHub
parent 577c4c1bec
commit ac1349ee83
2 changed files with 19 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
reference/pear/api.md
View File

@@ -168,6 +168,16 @@ Root directory of project.
Directory for Pear runtime.
### `Pear.config.dht.nodes <Array<Object>>`
A list of known [DHT](../../building-blocks/hyperdht.md) nodes of the form `{ host: <String>, port: <Number> }`. The nodes are set when the Pear application is started.
Unless started with a custom set of bootstrap nodes, Pear caches known nodes to speed up connecting to the swarm and to make it more resilient.
### `Pear.config.dht.bootstrap <Array<Object>>`
A list of custom bootstrap nodes Pear is started with of the form `{ host: <String>, port: <Number> }`.
## `Pear.checkpoint(<Any>) => Promise`
Stores state that will be available as `Pear.config.checkpoint` next time the application starts.