Module:CallAssert/doc - Revision history

Warudo: Added the page to :Category:Module documentation pages

2024-08-29T20:32:01Z

Added the page to Category:Module documentation pages

← Previous revision		Revision as of 20:32, 29 August 2024
Line 12:		Line 12:
	[[Category:Error-handling modules]]		[[Category:Error-handling modules]]
	}}</includeonly>		}}</includeonly>
			<noinclude>
			[[Category:Module documentation pages]]
			</noinclude>

Alexiscoutinho: Removed unnecessary supercategory

2021-07-05T21:25:12Z

Removed unnecessary supercategory

← Previous revision		Revision as of 21:25, 5 July 2021
Line 11:		Line 11:
	<includeonly>{{#ifeq:{{SUBPAGENAME}}\|sandbox \| \|		<includeonly>{{#ifeq:{{SUBPAGENAME}}\|sandbox \| \|
	[[Category:Error-handling modules]]		[[Category:Error-handling modules]]
	[[Category:Lua metamodules]]
	}}</includeonly>		}}</includeonly>

Dinoguy1000: this module is used on almost 200k pages, including system messages; this is inconsistent with an alpha rating (I have no opinion if the rating or the level of usage is "more" "correct", though changing the rating is considerably simpler and (ideally) less controversial than changing the level of usage)

2020-11-15T23:42:39Z

this module is used on almost 200k pages, including system messages; this is inconsistent with an alpha rating (I have no opinion if the rating or the level of usage is "more" "correct", though changing the rating is considerably simpler and (ideally) less controversial than changing the level of usage)

← Previous revision		Revision as of 23:42, 15 November 2020
Line 1:		Line 1:
	{{Module rating\|a}}		{{Module rating\|r}}
	{{used in system}}		{{used in system}}
	This [[Help:Lua metamodules\|metamodule]] provides function '''callAssert''', which simplifies error checking by throwing an error if a given function returns nil or false. This is similar to the built-in function [[mw:LUAREF#assert\|assert]], but unlike it, 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.		This [[Help:Lua metamodules\|metamodule]] provides function '''callAssert''', which simplifies error checking by throwing an error if a given function returns nil or false. This is similar to the built-in function [[mw:LUAREF#assert\|assert]], but unlike it, 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.

Pppery:

2019-03-11T00:07:23Z

← Previous revision		Revision as of 00:07, 11 March 2019
Line 1:		Line 1:
	{{Module rating\|a}}		{{Module rating\|a}}
			{{used in system}}

	This [[Help:Lua metamodules\|metamodule]] provides function '''callAssert''', which simplifies error checking by throwing an error if a given function returns nil or false. This is similar to the built-in function [[mw:LUAREF#assert\|assert]], but unlike it, 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.		This [[Help:Lua metamodules\|metamodule]] provides function '''callAssert''', which simplifies error checking by throwing an error if a given function returns nil or false. This is similar to the built-in function [[mw:LUAREF#assert\|assert]], but unlike it, 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.

Pppery at 19:29, 9 October 2018

2018-10-09T19:29:01Z

← Previous revision		Revision as of 19:29, 9 October 2018
Line 11:		Line 11:
	<includeonly>{{#ifeq:{{SUBPAGENAME}}\|sandbox \| \|		<includeonly>{{#ifeq:{{SUBPAGENAME}}\|sandbox \| \|
	[[Category:Error-handling modules]]		[[Category:Error-handling modules]]
			[[Category:Lua metamodules]]
	}}</includeonly>		}}</includeonly>

Petr Matas: /* top */

2018-08-20T19:28:27Z

top

← Previous revision		Revision as of 19:28, 20 August 2018
Line 1:		Line 1:
	{{Module rating\|a}}		{{Module rating\|a}}

	This [[Help:Lua metamodules\|metamodule]] provides function '''callAssert''', which simplifies error checking, ~~similarly~~ to the built-in function [[mw:LUAREF#assert\|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~~.		This [[Help:Lua metamodules\|metamodule]] provides function '''callAssert''', which simplifies error checking by throwing an error if a given function returns nil or false. This is similar to the built-in function [[mw:LUAREF#assert\|assert]], but unlike it, 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.

	== Usage ==		== Usage ==

Petr Matas: Creating Module:CallAssert/doc

2018-08-20T10:14:27Z

Creating Module:CallAssert/doc

New page

{{Module rating|a}}

This [[Help:Lua metamodules|metamodule]] provides function '''callAssert''', which simplifies error checking, similarly to the built-in function [[mw:LUAREF#assert|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''{{'}}, ...)'''

<code>callAssert</code> calls <code>''func''(...)</code> 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 <code>{{'}}''funcName''(''argument_values'') failed'</code>.
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
[[Category:Error-handling modules]]
}}</includeonly>