solid-cached-resource

Solid Cached Resource

Inspired by TanStack Query, with minimal API and footprint, built only for SolidJS. The (almost) same API as createResource. Includes createMutation for easier mutation state handling.

API references

Features:

• Create resource with the same key in multiple places - fetch once
• Cache results for next component mount, and refresh when wanted
• Mutate local resource by key after a successful remote mutation request

install

pnpm add solid-cached-resource

or npm/yarn

createCachedResource

Inspired by useQuery just for Solid createResource

import { createCachedResource } from "solid-cached-resource";

export const createGetUserById = (userId: Accessor<string>) => {
  return createCachedResource(
    () => ["user", userId()],
    async ([, userId]) => {
      const response = await fetch(`/users/${userId}`);
      return response.json();
    });
}

// MyComp.tsx
const [user] = createGetUserById(() => props.userId);

<div>{user().name}</div>

// MyOtherComp.tsx
const [user] = createGetUserById(() => props.userId);

<span>{user().name}</span>

In the case above, if props.userId has the same value, the key will be the same, so even though both components are creating the same resource with the same fetcher, only one request will be made to the server.

With options

createCachedResource accepts an optional options object as its third argument

{
  initialValue?: T (default undefined)
  refetchOnMount?: boolean (default true)
}

createMutations

Inspired by useMutation, with onSuccess hook, and mutateCachedValue utility function.

import {
  mutateCachedValue,
  createMutation,
} from "solid-cached-resource";

export const createUpdateUser = (userId: Accessor<string>) => {
  return createMutation(async (values) => {
    const response = fetch(`user/${userId()}`, {
      method: "POST",
      body: values,
    });
    return await response.json()
  }, {
    onSuccess: (user) => {
      mutateCachedValue(() => ["user", userId()], user);
    }
  });
}

mutateCachedValue will call the resources' mutate function with the provided key, so the signals will be updated across your components.