Interface TemplateArgument

The object that stores the properties of a template argument, used in Template.args.

Hierarchy

  • TemplateArgument

Properties

name: string

The argument name, from which unicode bidirectional characters and leading/trailing spaces are removed.

Note that this property is never an empty string even for unnamed arguments.

text: string

The argument's text created out of name and value, starting with a pipe character.

Note that the name is not rendered for unnamed arguments.

ufname: string

The unformatted argument name.

uftext: string

The argument's text created out of ufname and ufvalue, starting with a pipe character.

Note that the name is not rendered for unnamed arguments.

ufvalue: string

The unformatted argument value.

unnamed: boolean

Whether the argument is named.

value: string

The argument value, from which unicode bidirectional characters are removed. As for leading/trailing spaces, whether they are removed depends on whether the argument is named: Unnamed arguments ignore them, while named ones don't. Note, however, that trailing linebreak characters are always removed.

Generated using TypeDoc