JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
    • 0
  • Score
    100M100P100Q32338F
  • License AGPL-3.0

p2p db functions for chat

Package Exports

  • cabal-node
  • cabal-node/swarm.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (cabal-node) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

cabal-node

Node.js library for p2p functions for chat.

Usage

npm install cabal-node

API

Table of Contents

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.