readfile - Real Function Reference

readfile(path: string): string

Aliases

readfileasync

Arguments

string

required

File path resolved inside the workspace after separator normalization, workspace-boundary checks, and filename/extension checks. Absolute paths are accepted only if they resolve inside the workspace.

Returns

string

File contents returned as a Lua string with an explicit length. Bytes such as null bytes, line endings, and BOM bytes are not transformed by readfile.

Example

Read bytes from an existing workspace file.

local path = "examples/config.json"
writefile(path, '{"enabled":true}')

local content = readfile(path)
print(content)
print(#content)

​Aliases

​Arguments

​Returns

​Example

Aliases

Arguments

Returns

Example