Module:GetParameters/doc

From Funkinchan
Revision as of 08:25, 20 September 2023 by Jedevari (talk | contribs) (making module)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search

This is the documentation page for Module:GetParameters

Usage

getParameters

Takes 2 required arguments, frame_args and arg_list. Parses a frame's arguments, returning either the provided named arguments in arg_list if found or the positional parameters instead if not. This is designed to work around the stripping of values that takes place for defined parameters which could be important.

As an example, the calls <syntaxhighlight lang=lua inline>getParameters({"a", "b", "c"}, {"x", "y"})</syntaxhighlight> and <syntaxhighlight lang=lua inline>getParameters({x="a", y="b", z="c"}, {"x", "y"})</syntaxhighlight> would both give back <syntaxhighlight lang=lua inline>{x="a", y="b"}</syntaxhighlight>.

getBoolean

Takes 1 required argument boolean_str. Turns the input into a true/false boolean value based on the input. Will error if given anything other than a string or boolean value.

defined

To be invoked from inside a template instead of a module. Determines if a certain parameter is defined in the parent frame's arguments.

See also