npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@exobase/use-cached-response

v1.0.0-rc.25

Published

Exobase hook to help wire up response caching

Downloads

182

Readme


title: 'useCachedResponse' description: 'A hook to cache API responses' group: 'Hooks' badge: 'Caching'

An Exobase hook that will check incoming request argument for a match in the cache, if one exists it will be returned without executing the endpoint function.

Install

yarn add @exobase/use-cached-response
# or
yarn add @exobase/hooks

Import

import { useCachedResponse } from '@exobase/use-cached-response'
// or
import { useCachedResponse } from '@exobase/hooks'

Usage

import { compose } from 'radash'
import type { Props } from '@exobase/core'
import { useLambda } from '@exobase/use-lambda'
import { useCachedResponse, useServices } from '@exobase/hooks'

type Args = {
  id: string
}

export const findLibraryBookById = async ({ args }: Props<Args>) => {
  return db.libraries.find(args.id)
}

export default compose(
  useNext(),
  useServices({
    cache // an objects matching the Cache interface (having get and set functions)
  }),
  useCachedResponse({
    key: 'library.book.by-id',
    ttl: '1 hour'
  }),
  listLibraries
)

Using with Redis

Create a caching module. Here I'm using redis, you can using anything by implementing your own get and set functions.

// file: cache.ts
import { createClient } from 'redis'

const redis = createClient({
  url: config.redisUrl,
  username: config.redisUsername,
  password: config.redisPassword
})

redis.connect()

export default {
  get: (key: string) => redis.get(key),
  set: (key: string, value: string, ttl: number) =>
    redis.set(key, value, {
      EX: options.ttl
    })
}

Then, wire your caching module into the function's services so the useCachedResponse hook can use it

import cache from './cache'

export default compose(
  useNext(),
  useServices({
    cache
  }),
  useCachedResponse({
    key: 'library.book.by-id',
    ttl: '1 hour'
  }),
  listLibraries
)

Using with Composition

You probably don't want to import the cache in every endpoint function, you can compose it and create your own hook instead.

// file: useCache.ts
import { compose } from 'radash'
import type { Props } from '@exobase/core'
import { useCachedResponse, useServices } from '@exobase/hooks'
import type { UseCachedResponseOptions } from '@exobase/hooks'
import cache from './cache'

export const useCache = (opts: Pick<UseCachedResponseOptions, 'key' | 'ttl'>) =>
  compose(
    useServices({
      cache
    }),
    useCachedResponse({
      key: opts.key,
      ttl: opts.ttl
    })
  )

Now in your endpoint functions you can simply call your own useCache hook which will always come with the cache it needs.

import { useCache } from './useCache'

export default compose(
  useNext(),
  useCache({
    key: 'library.book.by-id',
    ttl: '1 hour'
  }),
  listLibraries
)