DirectoryWatcher.new Synchronous

Watch a workspace folder and get a signal whenever a file in it is created, edited, or deleted. It is handy for reloading a script or settings file as soon as you save it.

Syntax
Luau
DirectoryWatcher.new(folder: string) -> DirectoryWatcher

Parameters

Function parameters
ParameterTypeDescription
folderstringWorkspace-relative path of an existing folder.

Returns

DirectoryWatcher

A DirectoryWatcher whose OnChanged signal receives the path of each changed file.

DirectoryWatcher fields
Luau
DirectoryWatcher = {OnChanged: Signal}
FieldTypeDescription
OnChangedSignalSignal fired with the workspace path of each file created, edited, or deleted in the folder. Handlers may yield.

Usage notes

The folder is checked every 0.1 seconds. Files already present when the watcher is created do not fire; only later changes do. Subfolders are not watched.

Every check reads each file in the folder, so watch a small folder of your own rather than a large one. Call Destroy when you are done.

Example

Example
Luau
makefolder("watched")
local watcher = DirectoryWatcher.new("watched")
watcher.OnChanged:Connect(function(path)
    print("Changed:", path)
end)
writefile("watched/settings.json", "{}")
task.wait(1)
watcher:Destroy()
delfolder("watched")