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

brod-caster

v1.1.1

Published

Keep track of your micro-service messages and dispatch tasks accordingly

Downloads

6

Readme

BrodCaster

Combines Apache Kafka & Google Protocol Buffers

Watch your Kafka message queue and dispatch tasks accordingly.

As Kafka's literary executor, Max Brod refused to follow the writer's instructions to burn his life's work, and had them published instead. (Wikipedia)

How to use

var kafka = new BrodCaster();

kafka.on('myService', 'eventName', function(data) {
  console.log(data);
});

kafka.send('myService', 'eventName', { my: 'data' }, function(err, result) {
  console.log(err || result);
})

Options

Use with Kafka

{
  adaptor: {
    type: 'protocolBuffer',
    // Append this value to the `eventName` value
    package: 'com.takeaway.events.cdn.page',
    // Path to `protoc` compiled message descriptors
    // Envelope has to have a message called `Envelope`
    envelope: './events/envelope.desc',
    messages: './events/my-events.desc'
  },

  topics: [
    {
      topic: 'service-broadcast'
    }, {
      topic: 'foo',
      offset: 20
    }
  ],

  client: {
    connectionString: 'localhost:2181/',
    // Set your own client name
    clientId: 'brod-caster',
    zkOptions: {}, // see: node-zookeeper-client
  },

  consumer: {
    // Default value for `protocolBuffer` adaptor
    encoding: 'buffer'
  },

  producer: {

  },

  // Only for testing purposes
  producerInstance: myInstance
}

Pass in options.parser & options.serializer functions to skip using adaptor.

API

on(origin, status, cb)

  • origin: String
  • status: String
  • cb: function(data, raw)
    • data: Object, the additional data sent with the message
    • raw: Object, the original message the consumer instance got

send(origin, status, data, cb)

  • origin: String
  • status: String
  • data
    • message: String, (required) name of the message data gets serialized by
    • (toProto: function, (optional) returns serialized message as Buffer for envelope - currently not supported)
    • data: Object, contains all required fields to serialize Message message
  • options:
    • topics: Array
    • partition: Number
    • attributes: Number
  • cb: function(err, result)