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

@cactuslab/usepubsub

v1.0.2

Published

> A React hook to add Publish and Subscribe to a React application.

Downloads

5,283

Readme

usePubSub

A React hook to add Publish and Subscribe to a React application.

NPM JavaScript Style Guide

The usePubSub hook provides your React component with access to the current PubSubContext, on which you can publish messages to channels, and subscribe to channels to receive messages.

You provide a PubSubContext to your application using the <PubSubProvider> at the root level of your application (or wherever).

You may also explicitly create a PubSubContext using createPubSubContext() and provide it to <PubSubProvider context={myContext}>, and then use the publish, subscribe and unsubscribe methods of the PubSubContext anywhere in your application.

Install

npm install --save @cactuslab/usepubsub

Usage

import * as React from 'react'

import { usePubSub, PubSubProvider } from '@cactuslab/usepubsub'

/* Add a top-level PubSubProvider to your app to initialise the PubSub context */
const App = () => {
   return (
    <PubSubProvider>
      ...
    </PubSubProvider>
  )
}

const ExampleSubscriber = () => {
  const { subscribe } = usePubSub()
  React.useEffect(function() {
    return subscribe('CHANNEL', function(message) {
      ...
    })
  })
}

const ExamplePublisher = () => {
  const { publish } = usePubSub()
  
  function sendMessage() {
    publish('CHANNEL', nextMessage)
  }
}

Provide a custom context

Use createPubSubContext() to create the PubSubContext, and then call publish, subscribe and unsubscribe on it from anywhere in your application.

import { createPubSubContext, PubSubProvider } from '@cactuslab/usepubsub'

const myContext = createPubSubContext()

myContext.subscribe('ALERT_CHANNEL', function(message) {
  alert(message)
})

const App = () => {
  return (
    <PubSubProvider context={myContext}>
      ...
    </PubSubProvider>
  )
}

API Reference

type Handler = (message: unknown) => void

interface PubSubContext {
  publish: (channel: string, message: unknown) => void
  subscribe: (channel: string, handler: Handler) => () => void
  unsubscribe: (channel: string, handler: Handler) => void
}

/* Functions */
function createPubSubContext(): PubSubContext

/* Hooks */
function usePubSub(): PubSubContext

/* Components */
<PubSubProvider />
<PubSubProvider context={PubSubContext} />

License

MIT © Cactuslab


This hook is created using create-react-hook.