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

@roadmunk/events

v2.1.0

Published

The JS Protobufs generated by protoc.

Downloads

16

Readme

PubSub Events

This is the PubSub. The two functions we use are Publish and On.

Install

npm install --save @roadmunk/events

Build

npm run build

This will use docker to build and update required changes in dist. We do commit these files so we can add a link to the github for testing.

Usage

Clone the repo and run npm run docs. This will create the documentation and tutorials in the docs directory. You can also check out tutorials/on-tutorial.md or tutorials/publish-tutorial.md.

Testing out our changes

Create a branch with your changes and push it to github. In the repo you want to test with, update the package.json to point to the github URL plus branch. You may also need to remove package-lock.json to pick up any additional changes. If you need to iterate on changes to that branch, make sure not to use git --amend, or the new commit may not find its way into your docker containers.

{
  "dependencies": {
    "@roadmunk/events": "git://github.com/Roadmunk/events#YOUR_BRANCH_HERE"
  }
}

Note that if you are working in a fim-tools repo, such as fim-monolith, you will need to run npm install in /fim-tools (rather than /fim-tools/fim-monolith/api, as an) for your changes to appear.

SQS Queue Convention

The PubSub on function subscribes to SQS Queues under the covers. These queues are managed by each individual service. We use a convention to simplify our on functions by naming our SQS Queues with a few parameters.

With no Queue Group: https://sqs.${region}.amazonaws.com/${account}/${service}-${deployment}-${eventName}

With a Queue Group: https://sqs.${region}.amazonaws.com/${account}/${service}-${deployment}-${eventName}-${queueGroup}

Each service is expected to follow this naming convention so that we can abstract the internals away from each service. IE, Roadmapping doesn't need to know that it is subscribing to an SQS Queue, Kafka, or any other messaging client. It only needs to know that when an event is fired, it will receive that event. This should give us the option to switch messaging providers if we need to and simplifies the entire event system.