fs

local fs = require("@std/fs")

fs.close

(file: file) -> ()

fs.copy

(src: pathlike, dest: pathlike) -> ()

fs.createdirectory

(path: pathlike, options: createdirectoryoptions?) -> ()

fs.exists

(path: pathlike) -> boolean

fs.link

(src: pathlike, dest: pathlike) -> ()

fs.listdirectory

(path: pathlike) -> { directoryentry }

fs.metadata

(path: pathlike) -> metadata

fs.open

(path: pathlike, mode: handlemode?) -> file

fs.read

(file: file) -> string

fs.readfiletostring

(filepath: pathlike) -> string

fs.remove

(path: pathlike) -> ()

fs.removedirectory

(path: pathlike, options: removedirectoryoptions?) -> ()

fs.symboliclink

(src: pathlike, dest: pathlike) -> ()

fs.type

(path: pathlike) -> type

fs.walk

Note: for loops do not support yielding generalized iterators, so we cannot use fs.walk as for path in fs.walk(...) do directly. A while loop can be used instead. See example/walk_directory.luau for usage.

(path: pathlike, options: walkoptions?) -> () -> path?

fs.watch

Iterator function that yields filename and event pairs when changes occur in the watched path.

Also provides a close method to stop watching.

Note: for loops do not support yielding generalized iterators, so we cannot use fs.watch as for _ in fs.watch(...) do directly. A while loop can be used instead. See example/watch_directory.luau for usage.

(path: pathlike) -> watcher

fs.write

(file: file, contents: string) -> ()

fs.writestringtofile

(filepath: pathlike, contents: string) -> ()