Skip to content

Latest commit

 

History

History
401 lines (264 loc) · 11.8 KB

README.md

File metadata and controls

401 lines (264 loc) · 11.8 KB
Raw

WS+: Dead Simple WebSockets

tests

Dead simple WebSocket communication for both Node.js and in-browser.

  • Abstraction on top of the wonderful ws library
  • Event-based
  • Automatic reconnections
  • Automatic connection support
  • Subscription support
  • Async support
  • Vue plugin support
  • Fully tested
Contents

Requirements

  • Node 18+

Installation

npm install ws-plus

Usage Examples

Server

import { Server } from 'ws-plus'

// Start server on port
const server = new Server({ port: 8088 })

// React to an incoming message
server.on('ticket/request', (data, client) => {
    // Respond to client
    client.send('ticket/response', { ticket: '123' })
    // Or respond to all clients
    server.broadcast('ticket/response', ...)
})

Client

import { Client } from 'ws-plus'

const client = new Client('ws://localhost:8082')

// Observe connect events
client.on('connect', () => {
    console.info('Connection successful!')
})

// React to specific events
client.on('ticket/response', ({ ticket }) => {
    console.info(`Ticket received: ${ticket}`)
})

// Send a message
client.send('ticket/request', { someData: 'etc' })

Subscriptions

WS+ supports subscriptions to allow clients to only receive certain messages if they are interested in them. Example below.

Example

Server-Side
// Only clients that have subscribed to `specialMessage` will receive this
server.broadcastSubscribers('specialMessage', { secretCode: 1234 })
Client-Side
client.on('specialMessage', ({ secretCode }) => {
    // Do some secret things
})

// Required to receive the message above
client.send('subscribe', 'specialMessage')

Multiple Subscriptions

You can also subscribe to multiple actions at the same time:

client.send('subscribe', ['specialMessage', 'anotherAction'])

Unsubscribing

Unsubscribing is handled the same way as subscribing.

client.send('unsubscribe', ['specialMessage', 'anotherAction'])

Vue Plugin

When creating your app:

import { createSocket } from 'ws-plus/vue'

// Create your client
const socketClient = createSocket('ws://localhost:8082')

// Make socket available to all components
app.use(socketClient)

Usage in a Component (Options API)

export default {
    ...
    click() {
        this.$ws.send('ticket/request', { data: ... })
    }
}

Using in a Component (Composition API)

The listen helper automatically calls .on and .off for specified actions when the component is mounted and unmounted. Subscriptions can also be made automatically if desired.

import { inject } from 'vue'
import { listen } from 'ws-plus/vue'

function receive({ ticket }) {
    console.info(`Ticket received: ${ticket}`)
}

listen({
    'ticket/receive': receive
})

const ws = inject('$ws')
ws.send('ticket/request', { data: ... })

Multiple Clients

You can connect to multiple WebSocket servers by passing a different name when calling app.use() (Vue 3) or Vue.use() (Vue 2). The default name is ws.

import { createSocket } from 'ws-plus/vue'

// Connect to one client
const client1 = createSocket('ws://localhost:8082')
// Connect to another
const client2 = createSocket('ws://localhost:15600')

// Will be accessible as inject('$foo')
app.use(client1, { name: 'foo' })
// Will be accessible as inject('$bar')
app.use(client2, { name: 'bar' })

📝 API Docs

Class Client

Clients connect to other WebSocket servers and can be created either in a back-end (Node) or front-end (browser) environment.

All incoming messages are emitted as action events and can be subscribed to via client.on().

new Client(url : String, options? = { reconnectInterval?, maxQueueSize?, autoConnect?, serializer?, verbosity? })

Create a new WebSocket client.

  • url: URL to connect to (example: ws://localhost:8090)

Options:

  • autoConnect: Automatically connect during construction. Set this to false if you prefer to call .connect() manually. (default: true)
  • maxQueueSize: Maximum amount of messages to queue when not connected (for example, if still awaiting connection) (default: 100)
  • reconnectInterval: How many seconds to wait until attempting a reconnect when disconnected (default: 10)
  • serializer: Serializer class used for encoding/decoding messages (default: JSONArraySerializer). Accepts custom serializers, for more info see serialization.
  • verbosity: Show more/less log messages (default: 1). Set to 0 to silence.

Event: 'connect'

Emitted when connection to a server succeeds.

Event: 'close'

Emitted when the client closes, either normally or abnormally (E.G. during a reconnect).

client.broadcast(action : String, data : Any)

Send message to all other connected clients (including yourself).

Alias for calling client.send(action, data, true).

client.close()

Close socket.

client.connect()

Connect this client. Called automatically if reconnectInterval is set.

client.on(eventName : String, listener : function(data) {})

Listen for messages or events.

  • eventName: Event to listen for. Can be one of the default events or any message action sent by the server.
  • listener: Function to be called with data when action is received

client.off(eventName : String, listener : Function)

Stop listening for messages or events.

Alias for client.removeListener()

  • eventName: Event to unregister. Can be one of the default events or any message action sent by the server.
  • listener: Function to unregister

client.send(action : String, data : Any, bounce? : Boolean)

Send message to server.

  • action: Action name
  • data: Data to send
  • bounce: Bounce message back to this and all other connected clients on the server (default: false)

Class Server

Listens and waits for clients. Can only be used in back-end environments, not in-browser.

new Server(options? = { host?, port?, maxSendBuffer?, serializer?, verbosity?, ...wssOpts })

Create a new server.

Options:

  • host: Host to listen on (default: 127.0.0.1). Use 0.0.0.0 to accept any incoming connection.
  • port: Port to listen on (default: 8090)
  • maxSendBuffer: Size of the send buffer in bytes. This governs how much the server can queue to an unacknowledging recipient (for example, during slow connections) before giving up. Messages that exceed the send buffer are dropped. (default: 20000)
  • serializer: Serializer class used for encoding/decoding messages (default: JSONArraySerializer). Accepts custom serializers, for more info see serialization.
  • verbosity: Show more/less log messages (default 1). Use 0 to silence.
  • Any other option allowed in ws.WebSocketServer

Event: 'connect'

Special event emitted when a client connects to this server.

On emission, the listening function will be called with the ServerClient instance of the newly connected client.

Event: 'disconnect'

Special event emitted when a client disconnects from the server.

On emission, the listening function will be called with the ServerClient instance of removed client.

server.broadcast(action : String, data : Any, skipClient? : ServerClient) : Promise

Broadcast a message to all clients.

  • action: Action name
  • data: Data to send
  • skipClient: A ServerClient that should not receive this broadcast

server.broadcastSubscribers(action : String, data : Any) : Promise

Broadcast a message only to clients subscribed to this action.

For more information, see subscriptions.

  • action: Action name
  • data: Data to send

server.close() : Promise

Close this server. await this method to ensure all clients have disconnected.

server.on(eventName : String, listener : function(data, client) {})

Listen for specific message actions from clients or events.

  • eventName: Event to listen for. Can be one of the default events or any message action sent by a client.
  • listener: Function to be called with the incoming data and the specific client who sent it

Class ServerClient

A representation of each client connected to the server. These instances are automatically created by the server and should not be instantiated directly. However, ServerClient instances may be interacted with via event listeners on Server.

serverClient.deliver(action : String, data : Any) : Promise

Deliver a message to this client only. Rejects if message could not be delivered.

Useful for critical information.

  • action: Action name
  • data: Data to send

serverClient.send(action : String, data : Any) : Promise

Send a message to this client only. Failures will not reject, but will log.

  • action: Action name
  • data: Data to send

serverClient.toString() : String

Return a string representation of this client.

Vue Module (ws-plus/vue)

This module contains functions to ease development using Vue.js.

Usage Examples

createSocket(url: String, options? : {}) : Client

Create and return a reactive socket.

  • url: URL to connect to (example: ws://localhost:8090)
  • options: Options to pass to to Client (see new Client() for all options)

listen(actions : Object, options? : { name? : String, subscribe? : Boolean })

Register multiple listeners at once on a particular client.

  • actions: Object with action names as keys and listener functions as values

Options:

  • name: Websocket name to listen to (default: ws)
  • subscribe: Subscribe to passed actions (default: false)

Example:

function foo(incoming) {
    console.log(incoming)
}

listen({
    action1: foo,
    action2: foo
})

Equivalent to doing:

const client = inject('$ws')

client.on('action1', foo)
client.on('action2', foo)

onUnmounted(() => {
    client.off('action1', foo)
    client.off('action2', foo)
})

Notes on Serialization

By default, messages are serialized for transport using JSONArraySerializer, but any serializer that implements encode()/decode() is accepted during Server or Client instantiation.

Contributing & Tests

  1. Install development dependencies: npm install
  2. Run tests: npm test

License

MIT