Module:Arguments/doc: Difference between revisions

First, you need to load the module. It contains one function, named <code>getArgs</code>.

local getArgs = require('Module:Arguments').getArgs

In the most basic scenario, you can use getArgs inside your main function. The variable <code>args</code> is a table containing the arguments from #invoke. (See below for details.)

local getArgs = require('Module:Arguments').getArgs

local p = {}

return p

However, the recommended practice is to use a function just for processing arguments from #invoke. This means that if someone calls your module from another Lua module you don't have to have a frame object available, which improves performance.

local getArgs = require('Module:Arguments').getArgs

local p = {}

return p

If you want multiple functions to use the arguments, and you also want them to be accessible from #invoke, you can use a wrapper function.

local getArgs = require('Module:Arguments').getArgs

return p

=== Options ===

The following options are available. They are explained in the sections below.

local args = getArgs(frame, {

trim = false,

noOverwrite = true

})

=== Trimming and removing blanks ===

However, sometimes you want to use blank arguments as input, and sometimes you want to keep additional whitespace. This can be necessary to convert some templates exactly as they were written. If you want to do this, you can set the <code>trim</code> and <code>removeBlanks</code> arguments to <code>false</code>.

local args = getArgs(frame, {

trim = false,

removeBlanks = false

})

=== Custom formatting of arguments ===

Example 1: this function preserves whitespace for the first positional argument, but trims all other arguments and removes all other blank arguments.

local args = getArgs(frame, {

valueFunc = function (key, value)

end

})

Example 2: this function removes blank arguments and converts all arguments to lower case, but doesn't trim whitespace from positional parameters.

local args = getArgs(frame, {

valueFunc = function (key, value)

end

})

Note: the above functions will fail if passed input that is not of type <code>string</code> or <code>nil</code>. This might be the case if you use the <code>getArgs</code> function in the main function of your module, and that function is called by another Lua module. In this case, you will need to check the type of your input. This is not a problem if you are using a function specially for arguments from #invoke (i.e. you have <code>p.main</code> and <code>p._main</code> functions, or something similar).

{{cot|Examples 1 and 2 with type checking}}

Example 1:

local args = getArgs(frame, {

valueFunc = function (key, value)

end

})

Example 2:

local args = getArgs(frame, {

valueFunc = function (key, value)

end

})

{{cob}}

{{cot|Module:ExampleArgs code}}

local getArgs = require('Module:Arguments').getArgs

local p = {}

return p

{{cob}}

Wrappers can be specified either as a string, or as an array of strings.

local args = getArgs(frame, {

wrappers = 'Template:Wrapper template'

})

local args = getArgs(frame, {

wrappers = {

}

})

Notes:

Sometimes it can be useful to write new values to the args table. This is possible with the default settings of this module. (However, bear in mind that it is usually better coding style to create a new table with your new values and copy arguments from the args table as needed.)

args.foo = 'some value'

It is possible to alter this behaviour with the <code>readOnly</code> and <code>noOverwrite</code> options. If <code>readOnly</code> is set then it is not possible to write any values to the args table at all. If <code>noOverwrite</code> is set, then it is possible to add new values to the table, but it is not possible to add a value if it would overwrite any arguments that are passed from #invoke.