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

ls-events

v0.9.8

Published

Longshot Event Bus and Store

Downloads

11

Readme

Longshot Event Store API

Carl Winkler

Installation

npm install ls-events --save

Pre-requisites

Redis
This store uses Redis for its pub/sub and event storage.

Usage

All pub, sub and fetch methods return Promises.

Run your app with the --events hostname:port to pass in the Redis location.
If no runtime arguments are provided, 127.0.0.1:6379 are used as default.
This can be overridden with the setHost() function.

var events = require("ls-events");

// Subscribe to a pattern
events.psub("users/create/*", (ch, pt, msg) => {
	console.log("[CHANNEL: %s] Message: %s", ch, msg);
}).then(count => console.log("Successfully listening with %d others", count));

var newUser = {
	username: 'carl',
	email: '[email protected]',
	// ...
}
var newEvent = {
	event: 'create',
	context: 'users',
	key: 'carl', // Primary key of the object
	data: newUser
};

events.pub("users/create/carl", newEvent)
	.then(() => console.log("Successfully published!"));
// This will publish to the channel 'users/create/carl' (context/event/key)

/*
Console output:
>> Successfully listening with 1 others!
>> Successfully published!
>> [CHANNEL: users/create/carl] Message: { "usersname": "carl", "email": "[email protected]" }
*/

API

Event
{
	event: string, // operation type. E.g. create, read, update, delete, ...
	context: string, // object type. E.g. users, orders, invoices, ...
	key: string|number, // identifier of the object. typically the primary key.
	data: any // a POJO. This will get serialised and deserialsed using JSON.
}
Configuration

Configure the location of Redis.
Defaults to 127.0.0.1 and port 6379

function setHost(hostname: string, port?: number);
Subscribe

Subscribing to a simple channel such as: users/create/carl

function sub(channel: string, callback: (channel: string, message: any) =>  void): Promise<{}>;
Pattern Subscribe

Subscribing to a event that conforms to a pattern, such as:

  • users/create/*
  • users/*/*
  • users/*/carl
// Pattern: The pattern that was subscribed to
// Channel: The fully qualified channel that was published to
// Message: The message received
function psub(channel: string, callback: (pattern: string, channel: string, message: any) =>  void): Promise<{}>;
Publish

Publish an event. See the Event type.
The publish function automatically constructs the channel from the Event object provided.

function pub(event: Event): Promise<{}>;
Fetch

Fetches events from the event store.
context: object type. Such as 'users', 'orders', ... event: type of event. Such as 'create', 'update', 'delete', ... key: the key of the object. Typically the primary key. In the previous example this would be 'carl'.

function fetch(context?: string, event?: string, key?: string): Promise<FetchResult[]>;

interface FetchResult {
    channel: string;
    published: number; // Date.now() when it the event was published
    data: any; // Object
}