Module:Protect/doc
From Meta, a Wikimedia project coordination wiki
This is a documentation subpage for Module:Protect.
It contains usage information, categories, and other content that is not part of the original module page.
It contains usage information, categories, and other content that is not part of the original module page.
This is a documentation subpage for Module:Protect.
It contains usage information, categories, and other content that is not part of the original module page.
It contains usage information, categories, and other content that is not part of the original module page.
This module is rated as ready for general use. It has reached a mature form and is thought to be bug-free and ready for use wherever appropriate. It is ready to mention on help pages and other MetaWiki resources as an option for new users to learn. To reduce server load and bad output, it should be improved by sandbox testing rather than repeated trial-and-error editing.
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
[edit ]localprotect=require('Module:Protect') localprotectedFunc=protect(func,errFormat,options)
Arguments
[edit ]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
errFormatwill 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
[edit ]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
[edit ]localprotect=require('Module:Protect') localp={} functionp.main(frame) ifnotframe.args[1]then error('missing argument') end returnframe.args[1] end p.main=protect(p.main) returnp
Invoking the main function without arguments will output: Error: missing argument