luadocs/content/lua.scripts.api.manual/dtutils/prequire.md
Bill Ferguson b69d752221 [lua scripts] created manual from script comments
[lua scripts api] created manual from embedded library documentation

[lua api] created stub to contain lua api manual
2020-12-12 15:14:19 -05:00

774 B

title id weight draft author
prequire prequire 50 false people

NAME

prequire

SYNOPSIS

a protected lua require

USAGE

local du = require "lib/dtutils"
local status, lib = du.prequire(req_name)

req_name - string - the filename of the lua code to load without the ".lua" filetype

DESCRIPTION

prequire is a protected require that can survive an error in the code being loaded without bringing down the calling routine.

RETURN VALUE

status - boolean - true on success lib - if status is true, then the code, otherwise an error message

EXAMPLE

local status, lib = prequire("lib/dtutils.file") 

which would load lib/dtutils/file.lua which would return a status of true and the reference to the library.