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

@pager/event-sourcerer-client

v5.1.1

Published

event-sourcerer client

Downloads

2,060

Readme

event-sourcerer-client

Event Sourcing client

This client would be in charge of handling publishing of events to other services.

The intent is for this client to be the vehicle upon which our service broadcasts event-sourced data.

Usage Example

  • Require and Initialize
// Default configuration
const Jackrabbit = require('@pager/jackrabbit');
const { Client } = require('@pager/event-sourcerer-client');
const exchange = Jackrabbit('amqp://localhost').topic('events');
const client = Client.default(exchange);
// Manual setup
const Jackrabbit = require('@pager/jackrabbit');
const EventSourcerer = require('@pager/event-sourcerer-client');
const Client = EventSourcerer.Client;
const EventsTransport = EventSourcerer.transports.EventsTransport;

const exchange = Jackrabbit('amqp://localhost').topic('events');
const transport = new EventsTransport(exchange);
const client = new Client(transport);
  • Just use it to publish
const stream = 'chats';
const streamId = '123456';
const eventType = 'created';
const data = { 'name': 'my chat' };

client.publish(stream, streamId, eventType, data);

API Reference

Client

Client(transport)

  • transport - an instance of an object with a publish function that implements actual publishing of messages.

addPrePublishValidator(stream, eventType, schema)

Adds pre-publish payload validation.

  • stream - Name identifying the type of the stream, the stream is the category name to which we publish messages, analog to a model/entity name.
  • eventType - Name of the event.
  • schema - any valid Joi schema - will throw if invalid schema provided

After using this function, all publish payloads with this stream + eventType will be validated against the provided schema. Invalid payloads will throw a Joi validation error.

publish(stream, streamId, eventType, data)

  • stream - Name identifying the type of the stream, the stream is the category name to which we publish messages, analog to a model/entity name.
  • streamId - Identifier for a particular entity of the stream
  • eventType - Name of the event.
  • data - An object with fields and values for the event

Transports

SingleKeyRabbitTransport

This transport can be used to publish messages to a RabbitMQ instance, under a single key by stream. The key being events.{stream}.created.

SingleKeyRabbitTransport(publisher, metadata, logger)
  • publisher (required) - Configured rabbit exchange, as the one returned by @pager/jackrabbit's .topic() or .default(). Any publisher with a compatible interface will work
  • metadata - additional published metadata added on to the options param of publisher.publish
  • logger - optional override for default logger

MultiKeyRabbitTransport

This transport can be used to publish messages to a RabbitMQ instance, where every event is published to it's own key. The key being {stream}.{eventType}.

MultiKeyRabbitTransport(publisher, options)
  • publisher - Configured rabbit exchange, as the one returned by @pager/jackrabbit's .topic() or .default(). Any publisher with a compatible interface will work
  • logger - optional override for default logger

MultiTransport

This transport can be used to publish messages to a RabbitMQ instance, under a single key by stream. The key being events.{stream}.created.