Module:GetParameters/doc: Difference between revisions

Revision as of 13:06, 26 April 2020

Latest revision as of 21:33, 29 August 2024

(2 intermediate revisions by one other user not shown)

Line 1:

{{High use}}

{{Module rating |b<!-- Values: pre-alpha • alpha • beta • release • protected -- If a rating not needed/relevant, delete this template call -->}}

<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->

== Usage ==

=== getParameters ===

Takes 2 required arguments, <code>frame_args</code> and <code>arg_list</code>. Parses a frame's arguments, returning either the provided named arguments in <code>arg_list</code> 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 <code>boolean_str</code>. 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 ==

Line 9 ⟶ 20:

<!-- Categories below this line, please; interwikis at Wikidata -->

[[Category:Lua metamodules]]

}}</includeonly><noinclude>

[[Category:Module documentation pages]]

</noinclude>