@eryx/_fs_watch Module

JSON

Summary

Classes

WatchHandle
WatchHandle:stop() → ()
WatchHandle:ref() → ()
WatchHandle:unref() → ()

Functions

_fs_watch.create(path: string, recursive: boolean, callback: ((eventType: string, filename: string?) → ())) → WatchHandle

API Reference

Classes

WatchHandle

Properties

WatchHandle:stop

Stops the filesystem watcher and releases its resources.

WatchHandle:stop() → ()

WatchHandle:ref

Makes this handle keep the event loop alive (it is unref'd by default).

WatchHandle:ref() → ()

WatchHandle:unref

Allows the event loop to exit even while this handle is active (the default).

WatchHandle:unref() → ()

Functions

_fs_watch.create

Creates a low-level filesystem watcher. The callback is invoked with (eventType, filename?) each time the watched path changes. eventType is "change" or "rename". filename is the name of the changed file (may be nil on some platforms). Set recursive to true to watch subdirectories (supported on Windows and macOS; on Linux each subdirectory needs its own watcher).

_fs_watch.create(path: string, recursive: boolean, callback: ((eventType: string, filename: string?) → ())) → WatchHandle