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

@nyteshade/ne-pubsub

v2.1.2

Published

Simple but easy to use publisher/subscriber class

Downloads

8

Readme

PubSub Project

Overview

The PubSub project implements a simple yet powerful Publish/Subscribe pattern in JavaScript, enabling efficient and decoupled communication between different parts of your application. It's designed to be lightweight, easy to use, and flexible enough to cover a wide range of use cases.

Features

  • Event Management: Efficiently manage event subscriptions and publications.
  • Customizable Event Tracking: Option to track event publications.
  • Extended Logging and Error Handling: Specialized PubSub instances for logging (Logs) and error handling (Errors).
  • ES6 Module Support: Written as ES6 modules, making it modern and tree-shakable.
  • Test Suite: Includes a comprehensive Jest test suite.

Installation

To install the PubSub library, use npm or yarn:

npm install @nyteshade/ne-pubsub

or

yarn add @nyteshade/ne-pubsub

Usage

Here's a quick example to get you started:

import { PubSub } from '@nyteshade/ne-pubsub';

// Create a PubSub instance
const myPubSub = new PubSub('MyPubSub', ['event1', 'event2']);

// Subscribe to an event
myPubSub.listen('event1', (data) => console.log(`Received: ${data}`));

// Publish an event
myPubSub.publish('event1', 'Hello World!');

API Reference

PubSub Class

  • constructor(name, eventNames, [options]): Initializes a new instance of PubSub.
  • addEvent(eventName, ...subscribers): Adds a new event to track.
  • listen(eventName, subscriber, [thisObj], [options]): Subscribes to an event.
  • unlisten(eventName, subscriber): Unsubscribes from an event.
  • publish(eventName, ...args): Publishes an event to all subscribers.

Specialized Instances

  • Logs: For logging purposes.
  • Errors: For error handling.

Testing

To run the test suite, use the following command:

npm test

Contributing

Contributions are always welcome! Please follow these steps to contribute:

  1. Fork the Repository: Create your own fork of the project.
  2. Create a Feature Branch: Make your changes in a new branch.
  3. Run Tests: Ensure that all tests pass with your changes.
  4. Submit a Pull Request: Open a PR with a clear list of what you've done.

Reporting Issues

If you find any bugs or have a feature request, please file an issue in the GitHub issue tracker.

License

This project is licensed under MIT License.