Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yonathan06/solid-cached-resource
Cache Solidjs resources by key (derived from the resource source)
https://github.com/yonathan06/solid-cached-resource
cache solidjs
Last synced: 4 days ago
JSON representation
Cache Solidjs resources by key (derived from the resource source)
- Host: GitHub
- URL: https://github.com/yonathan06/solid-cached-resource
- Owner: yonathan06
- Created: 2022-03-25T12:28:36.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-25T08:09:23.000Z (5 months ago)
- Last Synced: 2024-12-09T16:45:23.956Z (13 days ago)
- Topics: cache, solidjs
- Language: TypeScript
- Homepage: https://yonathan06.github.io/solid-cached-resource/
- Size: 126 KB
- Stars: 36
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
  
# Solid Cached Resource
Inspired by TanStack Query, with minimal API and footprint, built only for SolidJS.
The (almost) same API as [createResource](https://www.solidjs.com/docs/latest/api#createresource).
Includes `createMutation` for easier mutation state handling.
[API references](https://yonathan06.github.io/solid-cached-resource/)
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
```sh
pnpm add solid-cached-resource
```
or `npm`/`yarn`
## createCachedResource
Inspired by [useQuery](https://react-query.tanstack.com/guides/queries) just for Solid `createResource`
```TypeScript
import { createCachedResource } from "solid-cached-resource";
export const createGetUserById = (userId: Accessor) => {
return createCachedResource(
() => ["user", userId()],
async ([, userId]) => {
const response = await fetch(`/users/${userId}`);
return response.json();
});
}
// MyComp.tsx
const [user] = createGetUserById(() => props.userId);
{user().name}
// MyOtherComp.tsx
const [user] = createGetUserById(() => props.userId);
{user().name}
```
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](https://yonathan06.github.io/solid-cached-resource/interfaces/CachedResourceOptions.html) object as its third argument
```TypeScript
{
initialValue?: T (default undefined)
refetchOnMount?: boolean (default true)
}
```
## createMutations
Inspired by [useMutation](https://react-query.tanstack.com/guides/mutations), with onSuccess hook, and `mutateCachedValue` utility function.
```TypeScript
import {
mutateCachedValue,
createMutation,
} from "solid-cached-resource";
export const createUpdateUser = (userId: Accessor) => {
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.