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

@profusion/apollo-query-ttl

v0.0.1

Published

This project provides an implementation of Apollo Hook Queries (useQuery and useLazyQuery) with a TTL (Time To Live) for cache hits.

Downloads

59

Readme

Apollo Queries With TTL

This project provides an implementation of Apollo Hook Queries (useQuery and useLazyQuery) with a TTL (Time To Live) for cache hits.

These hooks are useful when you want to control how long your queries can fetch data from cache. In another words, you can provide a TTL in miliseconds to the hook, it will use the cache-first fetch policy until the TTL time expires, the next fetch after expiration will use a network-only policy, then, the TTL will be applied again.

Check Apollo Client docs about fetch policy, here

Instalattion

$ npm i @profusion/apollo-query-ttl

$ yarn add @profusion/apollo-query-ttl

Hooks

This lib exports two hooks:

  • useQueryWithTTL: wraps Apollo's useQuery hook with TTL logic

Usage:

const QUERY = gql`
  query ContinentsQuery {
    data {
      id
      payload
    }
  }
`;

const TryQueryTTL = (): JSX.Element => {
  const { data } = useQueryWithTTL({
    query,
    queryOptions: {}, // you can provide all the options available on useQuery
    ttl: 10000, // it will allow cache hits for 10 seconds
  });

  return (
    <pre>
      {JSON.stringify(data)}
    </pre>
  )
}
  • useLazyQueryWithTTL: wraps Apollo's useLazyQuery hook with TTL logic

Usage:

const QUERY = gql`
  query ContinentsQuery {
    data {
      id
      payload
    }
  }
`;

const TryQueryTTL = (): JSX.Element => {
  const [fetch, { data }] = useLazyQueryWithTTL({
    query,
    queryOptions: {}, // you can provide all the options available on useQuery
    ttl: 10000, // it will allow cache hits for 10 seconds
  });

  return (
    <div>
      <pre>
        {JSON.stringify(data)}
      </pre>
      <button onClick={fetch}>Fetch!</button>
    </div>
  )
}

Typing the data

You can type your data and variables in the same way you do on default queries:

interface DataType {}
interface VariablesType {}

const { data } = useQueryWithTTL<DataType, VariablesType>({
  query,
  queryOptions: {
    variables: {},
  },
  ttl: 10000,
});

// data and queryOptions.variables will be
// typed as DataType and VariablesType, respectivelly