Skip to content

Commit 3d6cd3f

Browse files
docs(js-sdk): clarify when the watch exit callback receives an error
1 parent be5d95e commit 3d6cd3f

1 file changed

Lines changed: 3 additions & 0 deletions

File tree

  • packages/js-sdk/src/sandbox/filesystem

‎packages/js-sdk/src/sandbox/filesystem/index.ts‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -339,6 +339,9 @@ export interface WatchOpts extends FilesystemRequestOpts {
339339
timeoutMs?: number
340340
/**
341341
* Callback to call when the watch operation stops.
342+
*
343+
* `err` is `undefined` after {@link WatchHandle.stop} or a clean stream end,
344+
* and is set only when the watch fails.
342345
*/
343346
onExit?: (err?: Error) => void | Promise<void>
344347
/**

0 commit comments

Comments
 (0)