Document cacheTtl option and async query caching in useAgent hook#27029
Closed
agents-git-bot[bot] wants to merge 1 commit into
Closed
Document cacheTtl option and async query caching in useAgent hook#27029agents-git-bot[bot] wants to merge 1 commit into
agents-git-bot[bot] wants to merge 1 commit into
Conversation
This update adds documentation for the cacheTtl option in the useAgent hook, which was previously undocumented. The documentation clarifies: - Default cache behavior (5 minute TTL) - How to customize cache duration with cacheTtl - How to disable caching by setting cacheTtl to 0 - Cache invalidation with queryDeps This corresponds to a bug fix in cloudflare/agents PR #726 that corrected the behavior when cacheTtl is set to 0 (previously incorrectly cached for 5 minutes instead of disabling cache). Related: cloudflare/agents#726 🤖 Generated with Claude Code Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
agents-git-bot
Bot
requested review from
elithrar,
irvinebroque,
rita3ko,
thomasgauvin,
threepointone and
whoiskatrin
as code owners
December 9, 2025 23:52
github-actions
Bot
added
size/s
product:agents
github-actions
Bot
assigned
elithrar,
irvinebroque,
rita3ko,
thomasgauvin,
threepointone and
whoiskatrin
Contributor
|
This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:
|
Contributor
|
Preview URL: https://40aa36c5.preview.developers.cloudflare.com Files with changes (up to 15)
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR documents the
cacheTtloption and async query caching behavior in theuseAgentReact hook, which was previously undocumented in the Cloudflare Agents API reference.Changes
query,queryDeps, andcacheTtloptions to theUseAgentOptionstype definitioncacheTtlfor custom cache durations and how to disable cachingDocumentation Details
The documentation now clarifies:
cacheTtloptioncacheTtl: 0queryDepsfor cache invalidation when dependencies changeRelated Changes
This documentation update corresponds to a bug fix in the cloudflare/agents repository:
cacheTtlwas set to0(previously cached for 5 minutes instead of disabling cache)The bug fix ensures that setting
cacheTtl: 0properly disables caching, and this documentation clarifies this behavior for users.🤖 Generated with Claude Code