Getting Started

  • Introduction
  • Tutorial

API Reference

Getting Started

API Reference

Introduction

There are a number of great solutions for managing async fetch state in the React ecosystem but many of these require a non-trivial amount of boilerplate or framework knowledge to implement and maintain.

This project attempts to identify and abstract generic fetch state utilities into composable components that are as flexible and expressive as the underlying technologies they expose.

For more on the backstory, please check out the announcement on the Signal Sciences blog.

Motivation

  • reduce dependence on common boilerplate for managing fetch state
  • facilitate the collocation of data fetching alongside the components that rely on it
  • simplify cache management and invalidation

What does this do?

CacheCache is a context provider that exposes a map-like interface. This should be mounted near the top of your application tree similar to other context providers.
FetchFetch is a component that exposes a declarative interface for the fetch api. Its main job is to translate promise state into consumable props and provide methods to read, invalidate, and refresh fetch states.
ResourceResource glues together the above functionality with a more expressive interface. If Fetch represents an individual request state, a Resource can be thought of as a more generic entity description that defines and exposes additional or related actions for a given endpoint.

What doesn't this do?

Server-side rendering (SSR), and cache initialization from serialized state are not supported out of the box. This is because rsrc leverages raw promises rather than serialized objects to persist state internally.

That said, the cache component accepts any map-like interface, so it should be possible to serialize resolved states, and then rewrap them in promises before passing along to the cache provider.

References & Credits

Related projects, inspiration, and references:

Next
Tutorial