You are viewing documentation generated from a user contribution or an upcoming release. The contents of this document may not have been reviewed by the Deno team. Click here to view the documentation for the latest release.
Edit

File System Events

Concepts

  • Use Deno.watchFs to watch for file system events.
  • Results may vary between operating systems.

Example

To poll for file system events in the current directory:

/**
 * watcher.ts
 */
const watcher = Deno.watchFs(".");
for await (const event of watcher) {
  console.log(">>>> event", event);
  // Example event: { kind: "create", paths: [ "/home/alice/deno/foo.txt" ] }
}

Run with:

deno run --allow-read watcher.ts

Now try adding, removing and modifying files in the same directory as watcher.ts.

Note that the exact ordering of the events can vary between operating systems. This feature uses different syscalls depending on the platform:

OS Signals
Module Metadata