cabal-node

cabal-node

Node.js library for p2p functions for chat.

Usage

npm install cabal-node

API

Table of Contents

• Cabal
  • onconnection
  • joinChannel
  • leaveChannel
  • createReadStream
  • message
  • replicate

Cabal

Create a new Cabal. This is the object handling all local nickname -> cabal interactions for a single user.

Parameters

• storage (string | function) A hyperdb compatible storage function, or a string representing the local data path.
• href string The dat link
• opts Object Options include: username

onconnection

When a connection is made. Auto-authorizes new peers to write to the local database. Maintains the local view of visible users.

Parameters

• peer Object The discovery-swarm peer emitted from the 'connection' or 'disconnection' event

joinChannel

Join a channel.

Parameters

• channel String The channel to join.

leaveChannel

Leave a channel.

Parameters

• channel String The channel to leave.

createReadStream

Create a readable stream for the cabal channel.

Parameters

• channel String The channel you want to read from.

message

Create a message.

Parameters

• channel String The channel to create the message.
• message String The message to write.
• opts Object Options: date, username, type (i.e. message type)
• done function When message has been successfully added.

replicate

Replication stream for the cabal. Shares the username with the other peers it is connecting with.

Changelog

[2.3.0] - 2018-08-13

This version was published both as cabal-node and cabal-core.

Changed

• Sort the channel list alphabetically (#8) (@cinnamon-bun)