Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

socketier

m-bednar6ISCdeprecated1.0.6TypeScript support: included

Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

Small wrapper around ws package for convenient work with websockets.

ws, client, server, websocket, socket.io

readme

Socketier

Small, but useful wrapper around ws package. API similar to Socket.io, but without performance issues and long-polling.

Full documentation can be found here.

Server usage

import { SocketierServer } from 'socketier';

const server = new SocketierServer();

server.on('listening', () => console.log('Server listening'));

server.subscribe<string>('hello-world', (socket, data) => {
    console.log(`Socket data recieved: ${data}`);
    // Process data...
});

server.listen();   // DO NOT FORGET THIS LINE!!!

Client usage

For more convenient usage please use along with some bundling tool.

import { SocketierClient } from 'socketier/dist/client';

const client = new SocketierClient('ws://localhost:300');

client.on('connected', () => {
    console.log('Connection estabilished');
    // Send 'Hello world!' to the server
    client.send('hello-world', 'Hello world!');
});

client.connect();   // DO NOT FORGET THIS LINE!!!

You can also use client on server-side to connect server/node.js app to another Socketier server.

import { SocketierServer } from 'socketier';
import { SocketierClient } from 'socketier/dist/client';

const server = new SocketierServer();
const client = new SocketierClient('ws://another-socketier.com');

server.on('listening', () => {
    // Make connection, when server is ready
    client.connect();
});

server.subscribe<string>('hello-world', (socket, data) => {
    // Resend data to another server
    client.send('hello-world', data);
});

server.listen();