Module:Protect/doc explained

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

Function to be transformed.

• (default:)

Custom error message.

Use to include the message from a caught error.

• – optional table with the following fields:
  • (default: false)

If true, then will be used as is, otherwise it will be wrapped inside a tag <nowiki><strong class="error"></nowiki>.

• • (default: true)

If true, removes location information from caught error messages.

Return value

The resulting is a function, which calls the original function , passing all arguments to it, and returns all its return values. If 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 pInvoking the main function without arguments will output: Error: missing argument