JavaScript Client

symple-client is the browser and Node.js client. 9KB minified, no media dependencies.

Install

npm install symple-client

Connect

import SympleClient from 'symple-client'

const client = new SympleClient({
  url: 'ws://localhost:4500',
  token: 'optional-auth-token',
  peer: {
    user: 'alice',
    name: 'Alice',
    type: 'person'
  },
  reconnection: true,
  reconnectionDelay: 3000,
  reconnectionAttempts: 0  // 0 = unlimited
})

client.on('connect', () => console.log('online'))
client.connect()

Constructor options

Methods

connect()

Open a WebSocket connection and authenticate.

disconnect()

Close the connection gracefully. Stops reconnection.

shutdown()

Close the connection and nullify the socket.

send(message, to?)

Send any message. Sets type: 'message' if not specified. Generates an id if missing. Throws if offline.

client.send({
  subtype: 'chat',
  data: { text: 'Hello' }
}, 'bob|session-id')

sendMessage(message, to?)

Shorthand for send() with type: 'message'.

respond(message)

Send a reply -- swaps to and from from the original message.

sendPresence(p?)

Broadcast presence to all rooms. Merges peer data automatically.

join(room)

Join a dynamic room (requires dynamicRooms: true on server).

leave(room)

Leave a room.

addCapability(name, value?)

Add a capability to the local peer. Value defaults to true.

removeCapability(name)

Remove a capability and broadcast presence.

hasCapability(peerId, name)

Check if a remote peer has a capability.

getCapability(peerId, name)

Get the value of a remote peer's capability.

Properties

Events