Skip to content

Commit

Permalink
adding description for maxAge and description of how caching works
Browse files Browse the repository at this point in the history
  • Loading branch information
shashitnak committed Dec 26, 2023
1 parent 18972ed commit a35478f
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/operators/cache.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,12 @@ type User @cache(maxAge: 4000) {
}
```

## maxAge

the parameter `maxAge` takes a non-zero unsigned integer value which signifies the duration, in milliseconds, for which the value will be cached.

In the above example, the entire result of `posts` query will be cached for 3000ms. When the **@cache** operator is applied to a type, it is equivalent to applying it to each field individually. If for a type, one of the fields needs to be cached differently then this operator can be applied to that field separately and it will override the values provided for the type, as can be seen in the above example for `name` field in the `User` type.

# How does the caching work?

If **@cache** is set for a query or a field, the resolver for it will run once and the result will be stored in memory for `maxAge` milliseconds, and will expire after this duration. After the cache expires, the resolver will be run again to fetch the latest value and that value will then be cached.

0 comments on commit a35478f

Please sign in to comment.