Skip to content

Conversation

@agents-git-bot
Copy link
Contributor

@agents-git-bot agents-git-bot bot commented Jan 2, 2026

Synced from cloudflare/sandbox-sdk#324

Summary

Adds comprehensive documentation for the new file watching feature:

  • New API Reference: Complete documentation at /sandbox/api/file-watching/ covering:

    • watch() method with all options
    • WatchHandle interface for managing watchers
    • WatchEvent structure for file system events
  • Practical Examples: Real-world usage patterns including:

    • Filtering by file type with glob patterns
    • Watch cancellation with AbortController
    • Non-recursive watching
    • Event type filtering
    • Multiple simultaneous watchers
  • Best Practices: Guidelines for:

    • Proper cleanup with stop() and AbortSignal
    • Efficient filtering at the source
    • Error handling
  • API Index Updated: Added file watching card to /sandbox/api/ overview

Changes

  • src/content/docs/sandbox/api/file-watching.mdx - New comprehensive API documentation
  • src/content/docs/sandbox/api/index.mdx - Added file watching card to API overview

Related PR


🤖 Generated with Claude Code

@github-actions
Copy link
Contributor

github-actions bot commented Jan 2, 2026

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

Add comprehensive documentation for the new file watching feature:
- New /sandbox/api/file-watching/ page with complete API reference
- Examples for common use cases (filtering, cancellation, multiple watchers)
- Best practices and limitations
- Updated API index to include file watching

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
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