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

stups

v0.1.2

Published

React hook to do things on websocket events.

Downloads

592

Readme

useStups

React hook to do things on websocket events.

why?

While building a web app, we are often in a situation where we want to react to changes of server side data on the client. There are multiple ways to accomplish that. From SSE over websockets to paid services. This library aims on beeing a simple and small (< 4kB) solution to the problem. It's main feature is, that its well integrated with react and that it tries not to get in your way.

usage

useStups is a react hook that allows you to define an event and a some callback function that ist triggered when the defined event is sent on the websocket connection. To use it, you have to wrap your components in a <SubscriptionProder> context.

const App = () => {
  return (
    <SubscriptionsProvider endpointUrl="ws://localhost:8080/" token="someJWT">
      <Home></Home>
    </SubscriptionsProvider>
  );
};

The token attibute is optional and can carry a JWT which is sent to the endpoint, so the client can be authenticated.

Now the useStups hook can be used in your components.

export function Home() {
  const doSomething = React.useCallback(
    eventId => console.log(`Do something for event ${eventId}`),
    []
  );

  useStups('event:*', doSomething, 'home');

  return <div>Look at the console!</div>;
}

In this example, we listen for all events called 'event' and log to the console if the event occurs. By changing the event string, we can listen for a specific event ('event:123').

tip

Beein able to do something on data change is especially useful if you use it for refetching. Because useStups is unopinionated in what it does on events, you might use Apollo or React Query and pass the refetch function of a query to useStups. This way, the query can stay up to date with the server while not interfering with your caching strategy.

server side

For now, you can find an example implementation of an example server in example/server. In the future we might create a docker image that offers basic server capabilities.