Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/profusion/apollo-query-ttl
https://github.com/profusion/apollo-query-ttl
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/profusion/apollo-query-ttl
- Owner: profusion
- Created: 2021-07-21T21:45:55.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-11-10T12:09:21.000Z (about 3 years ago)
- Last Synced: 2024-04-15T02:01:57.428Z (8 months ago)
- Language: TypeScript
- Size: 160 KB
- Stars: 1
- Watchers: 20
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
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](https://www.apollographql.com/docs/react/data/queries/#supported-fetch-policies)
# Instalattion
```bash
$ 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:
```ts
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 (
{JSON.stringify(data)}
)
}
```
- `useLazyQueryWithTTL`: wraps Apollo's useLazyQuery hook with TTL logic
Usage:
```ts
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 (
{JSON.stringify(data)}
Fetch!
)
}
```
# Typing the data
You can type your `data` and variables in the same way you do on default queries:
```ts
interface DataType {}
interface VariablesType {}
const { data } = useQueryWithTTL({
query,
queryOptions: {
variables: {},
},
ttl: 10000,
});
// data and queryOptions.variables will be
// typed as DataType and VariablesType, respectivelly
```