websocket-events

2.0.0 • Public • Published

websocket-events

user events for WebSocket-Node connections.

NPM

Installation

npm i websocket-events

Usage

const websocket = require('websocket');
const events = require('websocket-events');
 
/* -- instance creation of http.Server is omitted -- */
 
const server = new websocket.server({httpServer: http});
 
server.on('request', request => {
    const connection = request.accept();
 
    connection.on('error', err => {
        if (err.userEventError) {
            console.log('user event error:', err);
        }
        else {
            console.log('error:', err);
        }
    });
 
    connection.on('close', (reasonCode, description) => {
        console.log('closed:', reasonCode, description);
    });
 
    // use here
    const options = {};
    events(connection, options);
 
    connection.on('user-event', data => {
        console.log('user-event:', data);
    });
 
    // this listener is only used when not set listeners
    connection.on('default', event => {
        console.log('default listener:', event.name, event.content);
    });
 
    // send user event as message of json data
    connection.send('user-event', { hoge: 'piyo' });
 
    // send normal text message
    connection.send('normal message');
});

💡 The example is used on the server, but it can also be used on the client.

Usable Options

eventKeyName

The name used as key of event name. Default value is @event.

defaultEventName

The name used when event listeners is not set. Default value is default.

License

MIT

Readme

Keywords

none

Package Sidebar

Install

npm i websocket-events

Weekly Downloads

4

Version

2.0.0

License

MIT

Unpacked Size

6.53 kB

Total Files

6

Last publish

Collaborators

  • marihachi