Solid Cached Resource (Experimental)
Create a solid resource attached to a cached state by a unique key. Heavily inspired by react-query, but for solid's createResource Works fluently with Solid, by keeping the same API as createResource, the resource source (the first function parameter signal) is being converted to a string key.
Features:
- Create resource with the same key in multiple places - fetch onces
- Cache results for next component mount, and refresh when wanted
- Mutate local resource by key after a successful mutation remote 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 = fetch(`/users/${userId}`);
return await 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 event 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 and optional options object as it's 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.
16 Nov 2, 2022
22 Dec 15, 2022
7 Dec 18, 2022
10 Dec 15, 2022
11 Dec 21, 2022
8 Nov 25, 2022
99 Dec 28, 2022
2.2k Jan 5, 2023
5 Jan 20, 2021
22 Dec 5, 2022