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

wse

v4.7.12

Published

Suspicious wrapper for ws with auth and custom protocol support.

Downloads

71

Readme

WSE

Client-centric WebSocket Expansion.

  • Easy client management;
  • Messaging protocol;
  • Simple authorization handler;
  • Custom Messaging Protocol Processor for real racers.
  • Basic Challenge-response Auth handlers.
  • WS Remote Procedures.

Installation

npm i wse -s

Usage

// server
import { WseServer } from 'wse'

// auth handler
function identify ({ payload, accept, meta }) {
  if (payload === SECRET) {
    const cid = 'any user id here'
    accept(cid, { hey: 'welcome back!' })
  } else {
    reject()
  }
}

const server = new WseServer({ port: 4200, identify })

server.broadcast('broad-message', { paylog: 'hey there!' })

server.channel.on('test-message', (conn, dat) => {
  console.log('we got test-message from', conn.cid, dat)

  conn.send('welcome-here', { payload: 42 })
})
// client
import { WseClient } from 'wse'

const client = new WseClient({ url: 'ws://lcoalhost:4200' })

await client.connect(SECRET)

client.when.ready(() => {
  client.send('test-message', { a: 1, b: 2 })
})

client.channel.on('welcome-here', (dat) => {
  console.log('got it', dat)
})

API Docs is in progress now. For more examples see: https://github.com/vovchisko/wse/tree/master/tests

Opt-in for performance

There are 2 optional modules that can be installed along side with the ws module. These modules are binary addons which improve certain operations.

npm install --save-optional bufferutil: Allows to efficiently perform operations such as masking and unmasking the data payload of the WebSocket frames.

npm install --save-optional utf-8-validate: Allows to efficiently check if a message contains valid UTF-8.

Read More: https://www.npmjs.com/package/ws#opt-in-for-performance

Todo:

  • server.useChallenge(()=>{}) - combine all arguments into an object.
  • client.connect() - let pass challenger.
  • add auto-reconnect (and it's prevention as well).