require

require(module) loads and executes a Lua module. CWD-jailed, searching the job’s directory first, then falling back to the project root. Dots in module names convert to path separators (e.g. foo.bar → foo/bar). For each location, it tries {path}.lua first, then {path}/init.lua, matching standard Lua convention. Modules are cached after first load.

Signature

require(module)

sync

Parameters

Param	Type	Description
module	string	Module name (dots converted to path separators)

Returns

Value	Type	Description
result	any	Return value of the module

Example

-- In hooks.lua
local utils = require("utils")
local result = utils.process_data(data)

-- In utils.lua (same job directory)
local M = {}
function M.process_data(data)
    return data:upper()
end
return M

See Also

• Lifecycle - How modules are loaded