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

@pennlabs/rest-live-hooks

v2.0.2-alpha.0

Published

React hooks for seamlessly integrating django-rest-live.

Downloads

17

Readme

REST Live Hooks

React hooks built to handle CRUD through RESTful APIs and realtime updates through websockets.

This package exposes two hooks, useRealtimeResource and useRealtimeResourceList. Both hooks have identical semantics to the respective hooks found in @pennlabs/rest-hooks, with one important distinction. These realtime hooks enable realtime updates via subscriptions based on the asynchronous websocket API defined by django-rest-live.

Because these hooks return the exact same values as the base rest-hooks, they can be used as drop-in replacements when you want to add realtime features to your React/Django app.

Documentation

Prior Reading

This library relies heavily on django-rest-live and rest-hooks for its functionality. It would be helpful to read through the README documentation for each of those libraries before moving on to this package.

Usage

The realtime hooks differ from the base REST hooks mostly in a subscribeRequest object that's added to every hook call. The object's structure is as follows:

const subscribeRequest = {
  model: "app.Model",
  property: "id",
  value: 5
}
  • model is a string label referring to the django model to subscribe to.
  • property is the optional "group key" discussed in the django-rest-live documentation. If it is not present, it defaults to the id field on the model, which is unique, so no grouping will occur. Make sure to add a group key for useResourceList.
  • value is the value match on for updates, generally an ID, either of the entity (for useRealtimeResource) or the grouped related object (for useRealtimeResource).

Here are the signatures for the two functions:

  • {data, error, isValidating, mutate } = useResource(url, subscribeRequest, configOptions)
  • {data, error, isValidating, mutate } = useResourceList(listUrl, getResourceUrl, subscribeRequest, configOptions)
    • configOptions takes in one additional optional property, sortBy, which will sort newly created elements that are added to the list. This is some code duplication from any ordering enforced on the back-end, but is necessary since the websocket subscription does not include all elements in the list, but only the new one.