Antt1995: 1 revision imported: New Files

2024-03-24T11:54:36Z

1 revision imported: New Files

← Older revision	Revision as of 11:54, 24 March 2024
(No difference)

Antt1995: Created page with "{{Documentation}} {{Wikipedia template}} == 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
2023-05-30T20:12:51Z

Created page with "{{Documentation}} {{Wikipedia template}} == 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 la..."

New page
{{Documentation}}
{{Wikipedia template}}

== 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 ==
* [[Module:Arguments]]