Giter VIP home page Giter VIP logo

simple-cache's Introduction

@matthamlin/simple-cache

A simple react-cache implementation that works for both Server Components and Client Components!

API

// For use on the client, or in client components during SSR
import { useCache } from '@matthamlin/simple-cache/client'

let cache = new Map()

interface Result {
  something: boolean
}

function useFetch(endpoint) {
  return useCache<Result>(cache, endpoint, () =>
    fetch(endpoint).then((data) => data.json()),
  )
}

Or with Server Components (experimental):

import { useCache } from '@matthamlin/simple-cache/server'

let cache = new Map()

interface Result {
  something: boolean
}

function useData(endpoint) {
  return useCache<Result>(cache, endpoint, () =>
    fetch(endpoint).then((res) => res.json()),
  )
}

useCache Arguments:

  • cache - A cache, expects the same api as a Map
  • key - A unique key (string) to index the cache by
  • miss - A function that returns a promise to suspend (function)

Recipes:

Sharing a cache between the server and the client:

Note I haven't done extensive testing with this approach, but it could work!

The server entrypoint also exports a serializeCache function that takes in the cache and returns a stringified representation of the cache. It's up to you to pass that data down to the client, one possible approach is a <script> tag injected alongside the component that suspended on the server!

On the client, you can import deserializeCache from the client entrypoint and pass that stringified representation to it to get back the cache which you can pass through to all useCache calls.

As long as the keys are equivalent, this should allow you to avoid double fetching on the client.

Note This doesn't yet work for pending useCache calls, not that I'd expect the server to flush those to the client ๐Ÿค”

Built Using:

  • Typescript
  • Babel

simple-cache's People

Contributors

dependabot[bot] avatar hamlim avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

simple-cache's Issues

Make Server Components Compatible

tl;dr:

  • useState
  • useEffect

don't work in server-components, we'll need to make the hook pure and remove the custom stuff.

Might also want to support additional functionality as well (e.g. mutations, etc)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.