Socket
Socket
Sign inDemoInstall

ts-simple-event-bus

Package Overview
Dependencies
0
Maintainers
1
Versions
14
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

ts-simple-event-bus

Simple TS event bus


Version published
Weekly downloads
154
decreased by-14.44%
Maintainers
1
Created
Weekly downloads
 

Readme

Source

TS-simple-event-bus

npm

A simple event bus that implements a pub / sub pattern. Fully typed.

Version 2.XX

Version 2 adds a typing that is defined once at the bus initialisation.

Use cases

Simple publish and subscribe:

import { EventBus, Callback } from "ts-simple-event-bus";
import { uuid } from "uuid";

// The typing is a nested object with queue names as keys and message payload as value
type EventBusTyping = {
  queue: {
    a: string;
    b: number;
  }
};

// Use a function to generate a unique id. You should provide the typing as well
const bus = new EventBus<EventBusTyping>(uuid);

bus.subscribe({ queue: "queue", callback: (message) => {
  console.log(message.id, message.a, message.b);
} });

bus.publish({ queue: "queue", { a: "a", b: 1 } });

Waiting for a response:

type EventBusTyping = {
  queue: {
    a: string;
    b: number;
  }
};
const bus = new EventBus<EventBusTyping>(idGenerator);
const responseQueueName = "event-response";
bus.subscribe({
  queue: "event-request",
  callback: (msg, id) => {
    bus.publish({ queue: responseQueueName, message: { event: "response" }, id });
  },
});
const result = await bus.publishAndWaitForResponse({
  queue: "event-request",
  responseQueue: responseQueueName,
  message: { event: "request" },
  timeout: 1000,
});
// result will be { event: "response" }

Version 1.XX

Use cases

Simple publish and subscribe:

import { EventBus, Callback } from "ts-simple-event-bus";
import { uuid } from "uuid";

type MessagePayload = {
  a: string;
  b: number;
};

// Use a function to generate a unique id.
const bus = new EventBus(uuid);
//
const callback: Callback<MessagePayload> = (message) => {
  console.log(message.id, message.a, message.b);
};

bus.subscribe<MessagePayload>({ queue: "queue", callback });

bus.publish<MessagePayload>({ queue: "queue", { a: "a", b: 1 } });

Waiting for a response:

const bus = new EventBus(idGenerator);
const responseQueueName = "event-response";
bus.subscribe({
  queue: "event-request",
  callback: (msg, id) => {
    bus.publish({ queue: responseQueueName, message: { event: "response" }, id });
  },
});
const result = await bus.publishAndWaitForResponse({
  queue: "event-request",
  responseQueue: responseQueueName,
  message: { event: "request" },
  timeout: 1000,
});
// result will be { event: "response" }

Keywords

FAQs

Last updated on 09 Jan 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc