Skip to content

[Sandbox] Document persistent file watch state#29021

Draft
whoiskatrin wants to merge 1 commit intoproductionfrom
sandbox-persistent-watch-docs
Draft

[Sandbox] Document persistent file watch state#29021
whoiskatrin wants to merge 1 commit intoproductionfrom
sandbox-persistent-watch-docs

Conversation

@whoiskatrin
Copy link
Contributor

Summary

  • document the new Sandbox persistent file watch APIs in the API reference, including ensureWatch(), getWatchState(), checkpointWatch(), and stopWatch()
  • explain when to use live watch() streams versus persistent watch state, including reconnect, checkpoint, and shutdown patterns
  • update the Sandbox overview example to replace the outdated callback-based file watching flow

Testing

  • npm run build
  • npm run check (currently fails because of the existing astro.config.ts:185 type error: processedDirs is not a known property)

@github-actions
Copy link
Contributor

This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:

Pattern Owners
/src/content/docs/sandbox/ @whoiskatrin, @ghostwriternr, @cloudflare/pcx-technical-writing, @cloudflare/ai-agents

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants