Module:CallAssert/doc: Difference between revisions

This metamodule provides function callAssert, which simplifies error checking, similarly to the built-in function assert. Unlike assert however, callAssert itself calls the function, whose return value is to be checked. This allows it to include the function name and argument values in the error message thrown if the check fails.

Usage

local callAssert = require('Module:CallAssert')
local result1, result2, etc = callAssert(func, 'funcName', ...)

callAssert calls func(...) and checks if the first returned value evaluates to true. If it does, then it returns all the returned values. If not, it throws an error with a message in the form 'funcName(argument_values) failed'.