开发者社区> 镜像站> NPM> ssb-party
ssb-party
ssb client-server party
Last updated 3 years ago by cel .
Fair · Repository · Original npm · Tarball · package.json
$ cnpm install ssb-party 
SYNC missed versions from official npm registry.

ssb-party

Get a scuttlebot client instance. If scuttlebot isn't running, start it in the background, and keep it running until all the clients have disconnected.

Usage

var createSsbParty = require('ssb-party')

createSsbParty([opts, ]cb)

  • opts.keys: an ssb-keys instance. default loads from ~/.ssb/secret
  • opts.host: host to connect to or start the server on. default "localhost"
  • opts.port: port to connect to or start the server on. default 8008
  • opts.appKey: secret-stack capability key (Buffer). default sbot's appKey

Other properties of the opts object will be used as ssb-config overrides, but if the server is already running, these will not affect the existing server's config.

Example

simplest case: connect to or start a local sbot:

var party = require('ssb-party')

party(function (err, sbot) {
  // ...
})

Config

  • config.timers.keepalive: minimum time (ms) to keep the server online after the last client disconnects. default: 30s
  • config.party.out: where to put standard output of sbot. may be a path (absolute, or relative to ssb's directory), or false to discard, or true to pass through to the controlling terminal. default: true
  • config.party.err: where to put standard error of sbot. default: same as config.party.out

License

Copyright (c) 2017 @cel

Usage of the works is permitted provided that this instrument is retained with the works, so that any entity that uses the works is notified of this instrument.

DISCLAIMER: THE WORKS ARE WITHOUT WARRANTY.

Current Tags

  • 0.5.1                                ...           latest (3 years ago)

6 Versions

  • 0.5.1                                ...           3 years ago
  • 0.5.0                                ...           3 years ago
  • 0.4.0                                ...           3 years ago
  • 0.3.0                                ...           4 years ago
  • 0.2.0                                ...           4 years ago
  • 0.1.0                                ...           4 years ago
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 1
Dependencies (14)
Dev Dependencies (2)
Dependents (2)