Module:Yesno/doc
This is the documentation page for Module:Yesno
Module:Yesno normalizes boolean-like inputs from MediaWiki frame arguments into explicit Lua booleans (true or false) or a fallback value.
Usage
Syntax
local yesno = require('Module:Yesno')
local bool = yesno(value, default)Behavior Matrix
| Input Type | Recognized Values | Return Value |
|---|---|---|
| Boolean | true / false |
Pass-through boolean |
| Truthy Strings | "yes", "y", "true", "t", "1", "on" (Case-insensitive, leading/trailing spaces ignored) |
true
|
| Falsy Strings | "no", "n", "false", "f", "0", "off" (Case-insensitive, leading/trailing spaces ignored) |
false
|
| Numbers | 1 / 0 |
true / false
|
| Unrecognized / Nil | Any other string, number, table, or nil |
default parameter value (or nil if omitted)
|
Examples
local yesno = require('Module:Yesno')
yesno('yes') -- returns true
yesno(' OFF ') -- returns false
yesno('unknown') -- returns nil
yesno('unknown', true) -- returns true
yesno(nil, false) -- returns false