模块:Protect/doc

这是Module:Protect的文档页面

这个模板被使用在系统讯息中。
对此模板的修改会立即反映在维基百科用户介面上，为避免造成大规模的影响，任何编辑应该先在此模板的沙盒页面、测试样例或您自己的用户子页面中测试，测试过后的修改才能在单次编辑中添加到此模板。请在做任何修改之前在此讨论页中进行讨论。

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

 local protect = require('Module:Protect')
 local protectedFunc = protect(func, errFormat, options)

Arguments

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">.
- removeLocation (default: true)
  If true, removes location information from caught error messages.

Return value

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

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