loadfile - Real Function Reference

loadfile(path: string, chunkName?: string): function | nil | string | nil

Aliases

loadfileasync
dofile
dofileasync

Arguments

string

required

File path resolved inside the workspace after separator normalization, workspace-boundary checks, and extension checks. Path, open, and read-size errors are thrown.

string

Optional chunk name passed to luau_load. Defaults to = when omitted or nil.

Returns

function | nil

Loaded Luau function when luau_load succeeds. The function is not executed by loadfile.

string | nil

Error string returned as the second value only when luau_load fails. Filesystem and path errors are thrown instead.

Example

Load a workspace Luau file as a function, then call it yourself.

writefile("examples/module.luau", "return 2 + 3")

local chunk, message = loadfile("examples/module.luau", "ExampleModule")

if chunk then
    print(chunk())
else
    warn(message)
end

​Aliases

​Arguments

​Returns

​Example

Aliases

Arguments

Returns

Example