feat: add file watching capabilities with inotify support #27382
Conversation
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
agents-git-bot
bot
requested review from
a team,
ghostwriternr and
whoiskatrin
as code owners
Contributor
|
This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:
|
agents-git-bot
bot
force-pushed
the
sync-docs-pr-324
branch
from
f04119c to
480beb6
Compare
Contributor
agents-git-bot
bot
force-pushed
the
sync-docs-pr-324
branch
2 times, most recently
from
0e13a53 to
b417ee8
Compare
agents-git-bot
bot
force-pushed
the
sync-docs-pr-324
branch
3 times, most recently
from
3807636 to
f038623
Compare
agents-git-bot
bot
changed the title
- Add API reference for file watching with watch() method documentation - Add comprehensive how-to guide for file watching workflows including hot reloading, test automation, and file synchronization - Update API index to include file watching section This documentation covers the new file watching capabilities with inotify support added in cloudflare/sandbox-sdk PR #324.
agents-git-bot
bot
force-pushed
the
sync-docs-pr-324
branch
from
f038623 to
7a73ada
Compare
agents-git-bot
bot
changed the title
Adds comprehensive documentation for the new file watching feature: - Documents watch() method with inotify-based filesystem monitoring - Covers event types (create, modify, delete, rename) - Explains WatchHandle interface and lifecycle management - Provides filtering examples with include/exclude patterns - Includes real-world use cases (hot reload, test runners, config monitoring) - Documents performance considerations and error handling - Updates API index page to include watching documentation Syncs with feat: add file watching capabilities with inotify support (sandbox-sdk PR #324)
- Add comprehensive API reference for file watching methods (watch, watchStream, stopWatch, listWatches) - Add detailed how-to guide covering basic usage, hot reloading, build integration, config monitoring - Include TypeScript examples, performance considerations, and best practices - Update main overview page with file watching feature highlight and example tab - Add file watching to API index navigation Relates to cloudflare/sandbox-sdk PR #324
Add comprehensive documentation for the new file watching feature: - API reference documentation with methods, types, and examples - How-to guide covering development tools and automation workflows - Integration with existing API reference navigation - Real-world examples for auto-reload, builds, and responsive dev tools
* Update deleting-data.mdx * added wrangler version to snapshot expiration * removed broken link until wrangler 4.56 is released * updated wrangler version updated wrangler version and added working references to wrangler commands. * corrected a note about snapshot expiration * Remove package.json and package-lock.json changes * Update src/content/docs/r2/data-catalog/deleting-data.mdx Co-authored-by: Jun Lee <[email protected]> --------- Co-authored-by: Jun Lee <[email protected]>
agents-git-bot
bot
requested review from
a team,
GregBrimble,
MattieTK,
WalshyDev,
irvinebroque and
mikenomitch
as code owners
agents-git-bot
bot
requested review from
a team,
Oxyjun,
aninibread,
elithrar,
harshil1712 and
jonesphillip
as code owners
Contributor
|
This PR requires additional review attention because it affects the following areas: PartialsThis PR updates partial files, which are pieces of content used across multiple files in our Render component.
|
|
01098814775 فودافون كاش
في الأربعاء، ١٤ يناير ٢٠٢٦، ١١:٣٥ م github-actions[bot] <
***@***.***> كتب:
… *github-actions[bot]* left a comment (cloudflare/cloudflare-docs#27382)
<#27382 (comment)>
This PR requires additional review attention because it affects the
following areas:
Partials
This PR updates partial files, which are pieces of content used across
multiple files in our Render component
<https://developers.cloudflare.com/style-guide/components/render/>.
- workers/wrangler-commands/r2 - view affected files
<https://developers.cloudflare.com/style-guide/components/render/?partial=workers/wrangler-commands/r2>
—
Reply to this email directly, view it on GitHub
<#27382 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/B3RKUIFOVV4RTVVOREGBX5T4G2ZBDAVCNFSM6AAAAACQROQQXOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZTONJRHAZDAMJSGA>
.
You are receiving this because you are subscribed to this thread.Message
ID: ***@***.***>
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 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
Add comprehensive documentation for the new file watching feature that enables real-time filesystem monitoring using Linux's native inotify system.
This documentation sync is for PR cloudflare/sandbox-sdk#324 which adds file watching capabilities to the Sandbox SDK.
Changes
/sandbox/api/file-watching/): Complete documentation forsandbox.watch()method,WatchHandleinterface, and all related types/sandbox/guides/file-watching/): Real-world examples and patterns for:Key Features Documented
inotifysystemUse Cases Covered
Related PR
The documentation follows Cloudflare docs style guidelines and includes comprehensive TypeScript examples using the
TypeScriptExamplecomponent.