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

event-transmitter

v2.0.0

Published

Transmit events over any stream pipeline.

Downloads

5,032

Readme

EventTransmitter for Streams

Build Status

Attach events to any stream pipeline and emit those events at receiving stream endpoints.

EventTransmitter transmits events and their parameters along standard stream pipelines. It requires at least two instances: one to transmit encoded event information, and another to listen for and emit events, sanitizing the stream of event metadata in the process for further piping.

Install

npm install --save event-transmitter

Include

var EventTransmitter = require('event-transmitter')

Transmit Events

Use EventTransmitter to transmit events (works like ee.emit). But first you must pipe your EventTransmitter instance to a stream that is connected to where you ultimately want to receive and handle events.

// create a new EventTransmitter instance
var et = new EventTransmitter()

// pipe the EventTransmitter to some outgoing stream
et.pipe(outgoing_stream)

// call et.transmit() to send an event down the pipeline
et.transmit('header', {name: 'Event A', codes: [222, 123, 456, 789]}, 'A String')

Receive and Emit Events Locally

Listen downstream for EventTransmitter events. Just pipe the stream containing the EventTransmitter events to a new EventTransmitter.Listener() which will listen for and emit them locally.

// create a new EventTransmitter instance
var etListener = new EventTransmitter.Listener()

// pipe some incoming stream containing encoded events to et.listen()
incoming_stream.pipe(etListener).pipe(process.stdout)

// set up your event handler to handle events from the pipeline
etListener.on('header', function(obj, str){
    console.log('emitting a "header" event with object:', obj, 'and string:', str)
})

Important

Note: EventTransmitter adds event metadata to the streams it is piped through and should be placed in the pipeline between where data will otherwise be used. Your EventTransmitter instance will sanitize stream content as it passes through its listener, removing event metadata from the stream, restoring the stream contents.

Have a look at the few examples in the package to see how to transmit events between various types of streams, sockets and processes.

License

The MIT License (MIT) Copyright (c) 2017 Arjun Mehta