Skip to main content

Templatevariable

Properties

NameTypeDescriptionNotes
key(optional) stringThe variable name as used when rendering context in templates.[default to undefined]
type(optional) stringThe data type for this variable. Use JSON Schema-like names for values (string, boolean, number, object, array) or "function" for template utility/helper functions (e.g. __dateTool.format(), __esc.html()).[default to undefined]
description(optional) stringHuman-readable description explaining what this variable represents.[default to undefined]
example(optional) anyExample value demonstrating the format and usage. For type "function", often a Velocity-style call (e.g. $__esc.html($value)). Can be a string, number, boolean, object, array, or null when no example is defined.[default to undefined]