peero-client v1.0.2

Javascript client for Peero server. The client connects to the server and connects to available peers.

Usage

var peero = new Peero({
    server: 'ws://127.0.0.1' // Required URL of Peero websocket server you want to connect to
})

// Sends 'register' request to server. The server will in turn send a peer ID and available peers.
peero.connect()

Sending messages

Send a message to all connected peers:

peero.messageAll('some message')

Send a message to one or multiple peers:

// peerId may be a single ID or an array of ID's
peero.message(peerId, 'some message')

Remove peer

Remove a single peer:

peero.removePeer(peerId)

Events

If you need to perform tasks after certain events, you can setup hooks in the options object of the constructor:

new Peero({
    server: 'ws://127.0.0.1',
    onRegister: function (peerId) {},
    onPeerConnect: function (peerId) {},
    onPeerClose: function (peerId) {},
    onPeerError: function (err, peerId) {},
    onMessageReceived: function (peerId, message) {},
    onMessageSent: function (err, peerId, message) {},
    onMessageSentAll: function (errors, message) {}
})

onRegister(peerId)

When the client receives a peer ID from the server. peerId is the peer ID of the client instance.

onPeerConnect(peerId)

When the client has successfully connected with another peer. peerId is the peer ID of the remote peer.

onPeerClose(peerId)

When the connection to a remote peer has closed, either manually or because of an error. peerId is the peer ID of the remote peer. The remote peer is automatically removed from the peero.peers list of peers.

onPeerError(err, peerId)

When a connection error occurs between the client and a remote peer.

onMessageReceived(peerId, message)

When a message is received from a remote peer.

onMessageSent(err, peerId, message)

When a message has been sent to a single peer. The event will fire multiple times if a message is being sent to multiple peers, e.g. when peero.messageAll() or peero.message([...]) is used.

onMessageSentAll(errors, message)

When a message has been sent to all peers. Will fire once and can contain multiple errors in the form of an object in which the keys are peer ID's and values are the errors themselves.