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

threadbridge

v1.0.1

Published

Utility TypeScript library that simplifies bi-directional communication between the main thread and web workers with full type safety. Use the same codebase to facilitate seamless and strongly-typed data exchange in both directions.

Downloads

218

Readme

ThreadBridge

A utility TypeScript library that simplifies bi-directional communication between the main thread and web workers with full type safety. This lightweight implementation extends the default API and requires no additional libraries. Use the same codebase to facilitate seamless and strongly-typed data exchange in both directions. Of course, it can be used in one direction if, for some reason, you do not want to use it for bi-directional communication

Install

Install the library using npm:

npm install threadbridge

Demo

codesandbox

Usage

This API was designed to be used in both the MainThread and WebWorker simultaneously. First, commands and messages are defined, followed by the data associated with them.

// Types.ts
export enum SenderCommands {
    Ping,
}

export interface SenderCommandsData {
    [SenderCommands.Ping]: { value: number };
}

export enum ReceiverMessages {
    Pong,
}

export interface ReceiverMessagesData {
    [ReceiverMessages.Pong]: { value: number };
}

Initialize WebWorker and pass it to bridge with types.

// MainThread.ts
import { ThreadBridge } from "threadbridge";
import { SenderCommands, SenderCommandsData, ReceiverMessages, ReceiverMessagesData } from "./Types";

const worker = new Worker("./Worker.ts");
const bridge = new ThreadBridge<SenderCommands, SenderCommandsData, ReceiverMessages, ReceiverMessagesData>(worker);

bridge.postMessage(SenderCommands.Ping, { value: 1 });
bridge.onMessage(ReceiverMessages.Pong, ({ value }) => {
    console.log(value);
});

Then use ThreadBridge in WebWorker to communication with MainThread.

// Worker.ts
import { ThreadBridge } from "threadbridge";
import { SenderCommands, SenderCommandsData, ReceiverMessages, ReceiverMessagesData } from "./Types";

const bridge = new ThreadBridge<ReceiverMessages, ReceiverMessagesData, SenderCommands, SenderCommandsData>(self);

bridge.postMessage(ReceiverMessages.Pong, { value: 2 });
bridge.onMessage(SenderCommands.Ping, ({ value }) => {
    console.log(value);
});

If u prefer to use named arrow functions you can do it this way:

const callback: ThreadBridge.ReceiverHandler<ReceiverMessages.Pong, ReceiverMessagesData> = ({ value }) => {
    console.log(value);
};

bridge.onMessage(ReceiverMessages.Pong, callback);

API

  • ThreadBridge<SenderCommands, SenderCommandsData, ReceiverMessages, ReceiverMessagesData>

    • constructor(worker: Worker | DedicatedWorkerGlobalScope)

      • Initializes the ThreadBridge with a worker or Window ( MainThread ).
    • postMessage(command: SenderCommands, data: SenderCommandsData[SenderCommands]): void

      • Sends a message to the worker.
    • onMessage(message: ReceiverMessages, handler: (data: ReceiverMessagesData[ReceiverMessages]) => void): void

      • Registers a handler to process incoming messages.
    • clearHandler(message: ReceiverMessages): void

      • Removes handler for the specific message.
    • clearAllHandlers(): void

      • Removes all handlers.

License

Distributed under the MIT License