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

ts-ws-machine

v1.0.2

Published

TypeScript WebSocket Client modelled as an FSM. Comes with reconnect and heartbeat support.

Downloads

790

Readme

ts-ws-machine

TypeScript WebSocket Client modelled as an FSM. Comes with reconnect and heartbeat support

Installation

npm install ts-ws-machine
yarn add ts-ws-machine

Usage

import { wsMachine, calcBackoff } from "ts-ws-machine";

const ws = wsMachine({
  url: "ws://localhost:3000/ws",
  pingTimeoutMillis: 10000,
  pongTimeoutMillis: 10000,
  backoffFn: calcBackoff,
  onMessage: (msg) => {
    console.log("Some websocket message", msg.data);
  }, 
  // Optional
  pingMsg: "MyPingMessage",
  // Optional
  pongMsg: "MyPongMessage",
  // Optional
  onStateChange: ({ previous, current }) => {
    console.log(`State changed: ${previous.tag} -> ${current.tag}`);
  },  
});

ws.connect();
ws.send("Msg to server");
// do other stuff
ws.disconnect();

Heartbeats

WSMachine will regularly send a ping message pingTimeoutMillis after it last received a response from the ws endpoint. After a ping message is sent it will wait up-to pongTimeoutMillis, if no response is received from the server within that time period, the underlying websocket will be closed and WSMachine will attempt to reconnect. If indeed a message is received (either a "pong" message or any other message really), a new ping will be scheduled.

Reconnect

WSMachine will automatically try to reconnect if the underlying websocket is closed or a heartbeat is missed. This lib comes with a default backoff implementation (calcBackoff) using an exponential backoff with some "jitter".

// attempt is current number of reconnects attempted
// randSeed is a random number between 0 and 1, initialized when you call then `wsMachine` function.
export type BackoffFn = (attempt: number, randSeed: number) => number

// constant backoff
const constantBackoff = (attempt: number, randSeed: number) => 1000;

// linear backoff
const linearBackoff = (attempt: number, randSeed: number) => 1000 * attempt;

// sort of random backoff :)
const randomBackoff = (attempt: number, randSeed: number) => 1000 * attempt * randSeed;

Config

  • url: A valid websocket url
  • pingTimeoutmillis: Number of milliseconds to wait since last hearing from the server before sending a ping message
  • pongTimeoutmillis: Number of milliseconds to wait for server to send a message response after a ping message has been sent
  • pingMessage: (optional) Custom ping message. Default is ping
  • pongMessage: (optional) Custom pong message. Default is pong
  • onMessage: Callback for messages from the server. Messages matching pongMessage are filtered out.
  • onStateChange: (optional) Callback for listening to state changes from the statemachine. Handy for debugging, or for displaying the health of your websocket connection.