fedwave-chat-client/README.md

fedwave-chat-client

Basic API client for [fedwave] chat. Provides minimal functionality.

Install with:

npm install fedwave-chat-client

---

Usage

import { FedwaveChat } from 'fedwave-chat-client';

const fedwaveChat = new FedwaveChat();

/* NOTE: These are the default implementations */

// 'ms' is an array of message objects delivered by the server
fedwaveChat.rcvMessageBulk = ms => {
  for( const m of ms ) {
    console.log( m.message );
  }
};

// Global chat setting
fedwaveChat.global = true;

// Connects to chat, to the specified room, with the token
// Note: the token cannot be changed after init()
fedwaveChat.connect( 'myroom', 'chat-token', 'fedwavechatserverurl' );

fedwaveChat.sendMessage( 'Hello, world!' );
fedwaveChat.room = 'global';
fedwaveChat.sendMessage( 'Hi, global' );

fedwaveChat.sendMessage({
  message: 'Hello, all',
  channel: 'markpugner',
  global: false,
  showBadge: true
});

The API is unstable because Fedwave itself is unstable. src/api.ts is entirely JSDoc annotated, so go there for documentation.