lukeed / sockette

https://github.com/lukeed/sockette


The cutest little WebSocket wrapper! 🧦



Sockette

Sockette

version travis downloads
The cutest little WebSocket wrapper! 🧦

Sockette is a tiny (339 bytes) wrapper around WebSocket that will automatically reconnect if the connection is lost!

Upon creation, the WebSocket is returned directly, exposing the native close and send methods.

In addition to attaching additional API methods, Sockette allows you to reuse instances, avoiding the need to redeclare all event listeners.

Install

$ npm install --save sockette

Usage

Unlike WebSocket, you should declare all event listeners on initializie

const Sockette = require('sockette');

const ws = new Sockette('ws://localhost:3000', {
  timeout: 5e3,
  maxAttempts: 10,
  onopen: e => console.log('Connected!', e),
  onmessage: e => console.log('Received:', e),
  onreconnect: e => console.log('Reconnecting...', e),
  onclose: e => console.log('Closed!', e),
  onerror: e => console.log('Error:', e)
});

ws.send('Hello, world!');
ws.close(); // graceful shutdown

// Reconnect 10s later
setTimeout(ws.reconnect, 10e3);

Note: You don't have to use new to instantiate!

const socket = require('sockette');
let ws = socket('ws://localhost:3000');

API

Sockette(url, options)

Returns: WebSocket

Returns the underlying WebSocket directly.

url

Type: String

The URL you want to connect to — Should be prefixed with ws:// or wss://. This is passed directly to WebSocket.

options.protocols

Type: String|Array

Either a single protocol string or an array of strings used to indicate sub-protocols. See the WebSocket docs for more info.

options.timeout

Type: Number
Default: 1000

The amount of time (in ms) to wait in between reconnection attempts. Defaults to 1 second.

options.maxAttempts

Type: Number
Default: Infinity

The maximum number of attempts to reconnect.

Important: Pass -1 if you want to disable this feature. Although, this is main reason to use Sockette! 😂

options.onopen

Type: Function

The EventListener to run in response to 'open' events. It receives the Event object as its only parameter.

This is called when the connection has been established and is ready to send and receive data.

options.onmessage

Type: Function

The EventListener to run in response to 'message' events. It receives the Event object as its only parameter.

This is called when a message has been received from the server. You'll probably want event.data~!

options.onreconnect

Type: Function

The callback to run when attempting to reconnect to the server.

If Sockette is automatically reconnecting in response to an error or unexpected close event, then your onreconnect callback will receive the forwarded Event object.

options.onclose

Type: Function

The EventListener to run in response to 'close' events. It receives the Event object as its only parameter.

This is called when the connection has been closed for any reason.

Important: If the error.code indicates an abnormal shutdown, an automatic reconnect attempt will be queued.

options.onerror

Type: Function

The EventListener to run in response to 'error' events. It receives the Event object as its only parameter.

This is called anytime an error occurs.

Important: If the error.code is ECONNREFUSED, an automatic reconnect attempt will be queued.

send(data)

Identical to WebSocket#send(), capable of sending multiple data types.

close(code, reason)

Nearly identical to WebSocket#close().

Important: If no code is specified, Sockette will send code 1000, indicating Normal Closure.

reconnect()

If options.maxAttempts has not been exceeded, enqueues a reconnection attempt.

open()

Initializes a new WebSocket — used on itialization and by reconnect().

License

MIT © Luke Edwards

Ещё не оценен

Последние записи

Архив

2018
2017
2016
2015
2014

Категории

Авторы

Ленты

RSS / Atom