Module:Protect/doc

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.

This module is rated as alpha. It is ready for third party input, and may be used on a few pages to see if problems arise, but should be watched. Suggestions for new features or changes in their input and output mechanisms are welcome.

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

local protect = require('Module:Protect') local protectedfunc = 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 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 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

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] return p.main = protect(p.main) return p

Invoking the main function without arguments will output: Error: missing argument