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

durablews

v1.0.1

Published

A resilient, TypeScript-based WebSocket client

Downloads

16

Readme

DurableWS (Durable Web Sockets)

DurableWS is a resilient, TypeScript-based WebSocket client designed for modern web applications. It offers robust connection handling, automatic reconnection with exponential backoff, idle detection, message queueing, and easy subscription management, ensuring your application maintains a reliable real-time connection under varying network conditions.

Features

  • Automatic Reconnection: Implements exponential backoff strategy to handle disconnections gracefully.
  • Idle Detection: Automatically detects idle states and triggers custom handlers.
  • Message Queueing: Outgoing messages are queued when the connection is down and sent when it's restored.
  • TypeScript Support: Fully typed interfaces for a better development experience.

Installation

npm install durablews

or

yarn add durablews

Basic Usage

To get started with DurableWS, first import the client in your project:

import { defineClient } from "durablews";

Create a new WebSocket client instance by specifying the configuration:

const client = await defineClient({
    url: "wss://your.websocket.server",
    autoConnect: true, // Automatically connects
    maxReconnectAttempts: 5,
    maxQueueSize: 50,
    idleTimeout: 300000, // 5 minutes
    getToken: async () => {
        const response = await fetch("/my/token/issuer");
        const data = await response.json();
        return data.token;
    }
});

Sending Messages

client.send({
    action: "greet",
    data: {
        message: "Hello, World!"
    }
});

Handling Events

client.onMessage((message) => {
    console.log("Received message:", message);
});

client.onOpen(() => {
    console.log("Connection opened");
});

client.onError((error) => {
    console.error("Connection error:", error);
});

client.onClose(() => {
    console.log("Connection closed");
});

client.onIdle(() => {
    console.log("Client is idle");
});

API Reference

defineClient(config: WebSocketClientConfig): Promise<WebSocketClient>

Initializes and returns a WebSocket client instance.

Config Options

  • url: WebSocket server URL.
  • autoConnect (optional): Whether to connect immediately upon instantiation.
  • maxReconnectAttempts (optional): Maximum number of reconnection attempts.
  • maxQueueSize (optional): Maximum size of the message queue.
  • idleTimeout (optional): Duration in milliseconds before the client is considered idle.
  • authTokenURL (optional): A URL for token issuance.
  • `getToken (optional): Function that returns a token for authentication. Can be synchronous or asynchronous.

WebSocketClient Methods

  • send(message: Record<string, unknown>): Send a message through the WebSocket connection.
  • subscribe(channelName: string): Subscribe to a channel.
  • connect(): Manually initiate the connection.
  • disconnect(): Disconnect the WebSocket connection.
  • isReady(): Returns a promise that resolves when the connection is ready.
  • getStatus(): Returns the current connection status.
  • onMessage(listener: OnMessageHandler): Register a message event listener.
  • onError(listener: OnErrorHandler): Register an error event listener.
  • onOpen(listener: OnOpenHandler): Register an open event listener.
  • onClose(listener: OnCloseHandler): Register a close event listener.
  • onIdle(listener: OnIdleHandler): Register an idle event listener.

Contributing

We welcome contributions! If you'd like to contribute, please fork the repository and use a feature branch. Pull requests are warmly welcome.

For major changes, please open an issue first to discuss what you would like to change.

License

Mozilla Public License 2.0