fs

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

Summary

Entry	Description
DirectoryEntry	Name + type pair returned by `listdir` for each child of a directory.
FileMetadata	Metadata for a filesystem entry — size, type, timestamps. Returned by `stat`.
copy	Copies the file at `src` to `dest`. Overwrites `dest` if it exists.
exists	Returns `true` if a file or directory exists at `path`.
listdir	Returns directory entries (name + type) for the immediate children of `path`.
mkdir	Creates a directory at `path`.
open	Opens the file at `path` in `mode` (`"r"`, `"w"`, `"a"`, etc.). Returns a
remove	Removes the file at `path`.
rmdir	Removes the directory at `path`. Fails if non-empty.
stat	Returns metadata (size, type, timestamps) for the file or directory at `path`.
type	Returns the type of the entry at `path` as a string — e.g. `"file"`, `"dir"`.

Name + type pair returned by listdir for each child of a directory.

type DirectoryEntry = runtime.FsDirEntry

Metadata for a filesystem entry — size, type, timestamps. Returned by stat.

type FileMetadata = runtime.FsStatResponse

Copies the file at src to dest. Overwrites dest if it exists.

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

Returns true if a file or directory exists at path.

(path: string) -> boolean

Returns directory entries (name + type) for the immediate children of path.

(path: string) -> { DirectoryEntry }

Creates a directory at path.

(path: string) -> ()

Opens the file at path in mode ("r", "w", "a", etc.). Returns a

stream handle usable with stream.read, stream.write, stream.close.

(path: string, mode: string?) -> stream.StreamHandle

Removes the file at path.

(path: string) -> ()

Removes the directory at path. Fails if non-empty.

(path: string) -> ()

Returns metadata (size, type, timestamps) for the file or directory at path.

(path: string) -> FileMetadata

Returns the type of the entry at path as a string — e.g. "file", "dir".

(path: string) -> string