Skip to content

docs(platform): clarify FileSystem.watch recursive option behavior #5792

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+6 −3
Open

docs(platform): clarify FileSystem.watch recursive option behavior #5792

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/platform-node/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -488,7 +488,7 @@

Added a `recursive` option to `FileSystem.watch` that allows watching for changes in subdirectories. When set to `true`, the watcher will monitor changes in all nested directories.

Note: The recursive option is only supported on macOS and Windows. On other platforms, it will be ignored.
Note: The `recursive` option behavior depends on the backend implementation. When using `@parcel/watcher` (default), watching is always recursive on all platforms and this option is ignored. When using the Node.js `fs.watch()` fallback, the `recursive` option is supported on all platforms (Node.js v20+).
Copy link
Contributor

@tim-smart tim-smart Nov 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

parcel watcher is not the default


Example:

Expand Down
7 changes: 5 additions & 2 deletions packages/platform/src/FileSystem.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -235,8 +235,11 @@ export interface FileSystem {
* By default, only changes to the direct children of the directory are reported.
* Set the `recursive` option to `true` to watch for changes in subdirectories as well.
*
* Note: The `recursive` option is only supported on macOS and Windows.
* On other platforms, it will be ignored.
* Note: The `recursive` option behavior depends on the backend implementation:
* - When using `@parcel/watcher` (default in `@effect/platform-node`):
* Watching is always recursive on all platforms. This option is ignored.
* - When using Node.js `fs.watch()` fallback: The `recursive` option is
* supported on all platforms (Node.js v20+).
*/
readonly watch: (path: string, options?: WatchOptions) => Stream<WatchEvent, PlatformError>
/**
Expand Down
Loading