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

@cprecioso/react-suspense

v3.1.0

Published

@cprecioso/react-suspense description

Downloads

356

Readme

React Suspense utils

$ npm i -D @cprecioso/react-suspense       # if you use npm
$ yarn add --dev @cprecioso/react-suspense # if you use yarn

Quick-start

A simple way to do a fetch while suspending the tree

import { bindKeyedSuspense } from "@cprecioso/react-suspense";

const { suspend: fetchPokemon } = bindKeyedSuspense((name: string) =>
  fetch(`https://pokeapi.co/api/v2/pokemon/${name}`).then((res) => res.json()),
);

const Pokemon = ({ name }: { name: string }) => {
  const data = fetchPokemon(name);
  return (
    <li>
      {data.name} is {data.height * 10}cm tall
    </li>
  );
};

const App = () => {
  const names = ["pichu", "pikachu", "raichu"];

  return (
    <ul>
      {names.map((name) => (
        <Pokemon key={name} name={name} />
      ))}
    </ul>
  );
};

export default App;

You can wrap these components in Suspenses, handle data fetching errors in your regular error boundaries, and use useDeferredValue and startTransition to defer the loading to the background.

API

See the docs

Guide

This library returns some functions named suspend. suspend() can be called from inside a component or a hook, and inside conditionals or loops, but not from other kinds of functions such as useEffect or code outside of a React tree.

The following functions are ordered from simple to more advanced:

bindSuspense

import { bindSuspense } from "@cprecioso/react-suspense";

const appConfig = bindSuspense(() =>
  fetch("/api/config").then((res) => res.json()),
);

export const Greeting = () => {
  const { accentColor } = appConfig.suspend();
  return <h1 style={{ color: accentColor }}>Hello world</h1>;
};

Pass it an async function, returns an object with:

  • suspend(): call it to suspend your tree while the async function resolves.

  • cache: an object that provides a get/set function to manually manipulate the cache. Useful to call cache.set(null) and force re-fetching.

bindKeyedSuspense

import { bindKeyedSuspense } from "@cprecioso/react-suspense";

const userInfo = bindKeyedSuspense((userId) =>
  fetch(`/api/user/${userId}`).then((res) => res.json()),
);

export const UserInfo = ({ userId }) => {
  const { name } = userInfo.suspend(userId);
  return <p>Name: {name}</p>;
};

Pass it an async function, returns an object with:

  • suspend(key): call it to suspend your tree while the async function resolves.

  • cache: an object that provides a get/set function to manually manipulate the cache. Useful to call cache.set(key, null) and force re-fetching.

createSuspense

createKeyedSuspense

Same as their bind counterparts. However, the async function is not passed when creating the cache, but when calling suspend: suspend(fn) / suspend(key, fn).

Custom Storage

All functions also accept an object as their last parameter, with the option storage. You can provide a backend for the cache, useful for using an LRU cache (quick-lru), avoiding holding references to the obejcts (WeakMap), or accepting multiple objects as the key (many-keys-map).

The object must implement get and set methods like those of Map.