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

Highway

v0.2.1

Published

An extremely flexible event emitter not only for web-workers.

Downloads

13

Readme

Highway.js

A flexible pub/sub event emitter for web-worker (and more) cross-communication with fallback support. Worker can be anything: an Iframe, a WebWorker, a ServiceWorker, a Node WS Server.

"Highway PubSub Cross-Communication"

Usage

Include Highway.js on both client side and worker side.

Import Highway and a Proxy you want to use, both in client side and worker side:

import Highway from 'Highway'
import WebWorkerProxy from 'Highway/Proxy/WebWorker'

Initialize:

// Client side
const Host = self.Worker ? new self.Worker('worker.bundle.js') : self
self.HW = self.HW || new Highway(new WebWorkerProxy(Host))
// Worker side
self.HW = self.HW || new Highway(new WebWorkerProxy(self))

Fallback when there is no worker support:

// On client side
if (!self.Worker) {
    const script = document.createElement('script')
    script.setAttribute('src', 'worker.bundle.js')
    document.body.appendChild(script)
}

In most cases you want to initialize client side stuff after the worker is loaded. Use your own event for this. For example you need your data model from the backend before rendering the site.

// Client side
HW.one('ready', InitSomeGUIFramework)
// Worker side
InitSomeDataModelStuff()
InitSomeWebSocketConnection()
HW.pub('ready')

API

HW.sub(string eventName, callable callback [,boolean one = false])

Subscribe to an event.

HW.sub('MyOwnEvent', function(){
    // Do something when event occurs
    // See pub, this will run 3 times
})
HW.sub('MyOwnEvent->DidSomething', function(){
    // Do something when event occurs
    // See pub, this will run once
})

HW.pub(eventName[, customData, customState])

Publish an event.

HW.pub('MyOwnEvent', { customData })
HW.pub('MyOwnEvent->DidSomething', { customData })
HW.pub('MyOwnEvent->IHaveState', { customData }, 'passed')

HW.one(eventName, callback)

Subscribe to an event, unsubscribe once it is called. It's a shorthand for HW.sub(eventName, callback, true)

HW.one('MyOwnEventOnce', function(){
    // I'll just run once and automatically unsubscribe then
})

HW.exe(callable)

Execute a function on the other side. Your function will be executed within self context.

HW.exe(() => {
    // Do some code
})

Disable exe

HW.AllowExe = false

You might want to disable this if you're using Node as you backend for example. Function is passed over as a string and it's executed by eval which is a high security risk.

off

Unsubscribe from an event.

// Unsubscribe from ALL events associated with MyOwnEvent
HW.off('MyOwnEvent')
// Unsubscribe only a specific callback
HW.off('MyOwnEvent', callback)
// Unsubscribe from ALL events associated with MyOwnEvent, even the deep ones. eg: MyOwnEvent->DeepEvent too
HW.off('MyOwnEvent', true)

destroy

Destroy the Highway instance.

HW.destroy()

Proxies

  • EventEmitter: for everything which uses the node EventEmitter interface (like socket.io)
  • Iframe
  • WebWorker: for both Web and Service Workers

Credits

Victor Vincent