Module:Protect/doc
Li
This is the documentation page for Module:Protect
This Lua module is used in system messages, and on approximately 228,000 pages. Changes to it can cause immediate changes to the Wikipedia user interface. To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Please discuss changes on the talk page before implementing them. |
This metamodule simplifies error handling in other modules. It transforms a function, which may throw an error, into a function, which returns a specified error message in that case.
Usage
[jhyuk a̱tyin ka] local protect = require('Module:Protect')
local protectedFunc = protect(func, errFormat, options)
Arguments
[jhyuk a̱tyin ka]func
- Function to be transformed.
errFormat
(default:'Error: %s'
)- Custom error message.
- Use
'%s'
to include the message from a caught error.
options
– optional table with the following fields:raw
(default: false)- If true, then
errFormat
will be used as is, otherwise it will be wrapped inside a tag<strong class="error">
.
- If true, then
removeLocation
(default: true)- If true, removes location information from caught error messages.
Return value
[jhyuk a̱tyin ka]The resulting protectedFunc
is a function, which calls the original function func
, passing all arguments to it, and returns all its return values. If func
throws an error, the specified error message is returned instead.
Example
[jhyuk a̱tyin ka]local protect = require('Module:Protect')
local p = {}
function p.main(frame)
if not frame.args[1] then
error('missing argument')
end
return frame.args[1]
end
p.main = protect(p.main)
return p
Invoking the main function without arguments will output: Error: missing argument