Module:Yesno

This module is a helper module to be used by other modules; it may not designed to be invoked directly. See RuneScape:Lua/Helper modules for a full list and more information. For a full list of modules using this helper click here

Function	Type	Use
`(arg)`	Any value	Reads arg for yes/no and returns the appropriate boolean or nil
`(arg1,arg2)`	Any value, Any value	Reads arg1 for yes/no and returns the appropriate boolean; returns arg2 if arg1 was not an applicable value

--[[
{{Helper module|name=Yesno
|fname1=(arg)
|ftype1=Any value
|fuse1=Reads arg for yes/no and returns the appropriate boolean or nil
|fname2=(arg1,arg2)
|ftype2=Any value, Any value
|fuse2=Reads arg1 for yes/no and returns the appropriate boolean; returns arg2 if arg1 was not an applicable value
}}
--]]
-- <pre>
-- Used to evaluate args to booleans where applicable
--
-- Based on <https://en.wikipedia.org/wiki/Module:Yesno>
-- see page history there for contributors
--

return function( arg, default )
    arg = type( arg ) == 'string' and mw.ustring.lower( arg ) or arg

    if arg == nil then
        return nil
    end

    if
        arg == true or
        arg == 'yes' or
        arg == 'y' or
        arg == 'true' or
        tonumber( arg ) ==  1
    then
        return true
    end

    if
        arg == false or
        arg == 'no' or
        arg == 'n' or
        arg == 'false' or
        arg == '' or
        tonumber( arg ) == 0
    then
        return false
    end

    return default
end