npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@egodigital/ws

v0.5.0

Published

Simple socket server and client classes.

Downloads

14

Readme

npm

node-ws

A simplfied library for Node.js 10+ for handling WebSocket connections, written in TypeScript.

Install

Execute the following command from your project folder, where your package.json file is stored:

npm install --save @egodigital/ws

Usage

With Express

You are able to share the same port with an express and web socket instance.

import * as express from 'express';
import { SimpleWebSocket, withExpress } from '@egodigital/ws';

// ##### SERVER #####

// Express instance
const app = express();

// http://localhost:8080/
app.get('/', (req, res) => {
    return res.status(200)
        .send('Hello, from Express!');
});

// setup websocket server with Express app
const { server, listen } = await withExpress({
    app: app,
    key: 'ego',  // a string or buffer
                 // for authentication
});

// handle messages of type 'HelloEGO'
server.onMessage(async (ctx) => {
    console.log('server.onMessage', ctx.message);

    // optional data, which should be
    // send with OK message
    return 23979;
}, (msg) => 'HelloEGO' === msg.type);

// start listening on port 8080
await listen(8080);


// ##### CLIENT #####

// connect to local server
const client = SimpleWebSocket.fromUrl('ws://localhost:8080');

// handle messages of any type from server
client.onMessage((ctx) => {
    console.log('client.onMessage', ctx.message);
});

await client.connect('ego');  // same key as submitted to 'withExpress()'
                              // s.a.

// send message of type 'HelloEGO'
// and data 5979 to local server
await client.send('HelloEGO', 5979);

Events

// SimpleWebSocket
client.on('message', (msg, client) => {
    // handle message from remote server
});
client.on('close', () => {
    // connection with remote server has been closed
});

// SimpleWebSocketServer
server.on('connection', (client, server) => {
    // new connection with 'client'
});
server.on('message', (msg, client, server) => {
    // handle message from remote client
});
server.on('close', (client, server) => {
    // connection with remote client has been closed
});

Documentation

The API documentation can be found here.