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

@podium/browser

v1.2.1

Published

Podium browser library.

Downloads

2,788

Readme

@podium/browser

Podium browser library.

Dependencies GitHub Actions status Known Vulnerabilities

Currently this module only includes MessageBus, but it is possible that it will include more features in the future.

Installation

$ npm install @podium/browser

MessageBus

Cross podlet communication and message passing.

Simple usage

// In podlet A. Broadcast an event
import { MessageBus } from '@podium/browser';

const messageBus = new MessageBus();

messageBus.publish('search', 'query', 'couch');

// In podlet B. Subscribe to an event
import { MessageBus } from '@podium/browser';

const messageBus = new MessageBus();

messageBus.subscribe('search', 'query', event => {
    console.log(event.payload);
});

Constructor

Create a new MessageBus instance.

const messageBus = new MessageBus();

API

.publish(channel, topic, payload)

Publish an event for a channel and topic combination. Returns the event object passed to subscribers.

This method takes the following arguments:

| option | default | type | required | details | | ------- | ------- | -------- | -------- | ------------------------- | | channel | null | string | true | Name of the channel | | topic | null | string | true | Name of the topic | | payload | null | any | false | The payload for the event |

Examples:

messageBus.publish('search', 'query', 'laptop');

messageBus.publish('auth', 'logout');

.subscribe(channel, topic, callback)

Subscribe to events for a channel and topic combination.

This method takes the following arguments:

| option | default | type | required | details | | -------- | ------- | ---------- | -------- | --------------------------------------------------------- | | channel | null | string | true | Name of the channel | | topic | null | string | true | Name of the topic | | callback | null | Function | true | Callback function to be invoked. Receives an event object |

Example:

messageBus.subscribe('channel', 'topic', event => {
    console.log(event.payload);
});

.unsubscribe(channel, topic, callback)

Unsubscribe to events for a channel and topic combination.

This method takes the following arguments:

| option | default | type | required | details | | -------- | ------- | ---------- | -------- | ---------------------------- | | channel | null | string | true | Name of the channel | | topic | null | string | true | Name of the topic | | callback | null | Function | true | Callback function to remove. |

Example:

function cb(event) {
    console.log(event.payload);
}

messageBus.subscribe('channel', 'topic', cb);

messageBus.unsubscribe('channel', 'topic', cb);

.peek(channel, topic)

Get the latest event for a channel and topic combination.

This method takes the following arguments:

| option | default | type | required | details | | ------- | ------- | -------- | -------- | ------------------- | | channel | null | string | true | Name of the channel | | topic | null | string | true | Name of the topic |

.log(channel, topic)

Returns an array of the 10 latest events for a channel and topic combination. The array is ordered such that the the latest/newest events is at the front of the array.

This method takes the following arguments:

| option | default | type | required | details | | ------- | ------- | -------- | -------- | ------------------- | | channel | null | string | true | Name of the channel | | topic | null | string | true | Name of the topic |

Example:

const events = messageBus.log('channel', 'topic');

events.forEach(event => {
    console.log(event.payload);
});

Implementation

MessageBus uses a global singleton to coordinate message passing between different instances. This is something you need to be aware of, for instance, if writing unit tests. See MessageBus.test.js for an example.

License

Copyright (c) 2019 FINN.no

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.