Interface NewArg

The object that specifies what kind of a template argument should be added to Template.args.

Used in Template.addArgs and Template.setArgs.

Hierarchy

  • NewArg

Properties

Properties

forceUnnamed?: boolean

Forcibly register this (integer-named) argument as unnamed. Ignored if name (after being formatted) is not of an integer.

name: string

The name of the new argument. This can be an empty string if the class should automatically assign an integer name in accordance with the arguments that have already been registered.

This property accepts leading/trailing spaces, for an output of e.g. | 1 = value instead of |1=value (a config object must be passed to Template.render for this output).

value: string

The value of the new argument.

This property accepts leading/trailing spaces, for an output of e.g. | 1 = value instead of |1=value (a config object must be passed to Template.render for this output). It can also end with \n when the argument should have a linebreak before the next argument or }} (although whether to add a new line should instead be specified by passing RenderOptions.linebreak or RenderOptions.linebreakPredicate to Template.render).

Generated using TypeDoc