readfile

Returns the full contents of the file at path as a single string.

readfile(path: string): string

path is workspace-relative. There’s no encoding step - you get the exact bytes that are on disk, so binary files read fine too.

Parameters

Parameter	Type	Description
path	string	File to read.

Returns

string - raw contents of the file. The string can contain any byte value, including embedded "\0" and binary data.

Example

Load a saved config back into a Lua table:

Example 1

<<<<<<< HEAD
local content = readfile("hello.txt")
=======
-- readfile(path: string): string
>>>>>>> 50e30f53759b0538759af25c9b271514aa2c9290

Always check isfile() before reading to avoid runtime errors.