Loops

Here’s how you can iterate over a list of items, accessing each item’s attributes:

1function MyFunc(messages: Message[]) -> string {
2  prompt #"
3    {% for message in messages %}
4      {{ message.user_name }}: {{ message.content }}
5    {% endfor %}
6  "#
7}

loop

Jinja provides a loop object that can be used to access information about the loop. Here are some of the attributes of the loop object:

VariableDescription
loop.indexThe current iteration of the loop. (1 indexed)
loop.index0The current iteration of the loop. (0 indexed)
loop.revindexThe number of iterations from the end of the loop (1 indexed)
loop.revindex0The number of iterations from the end of the loop (0 indexed)
loop.firstTrue if first iteration.
loop.lastTrue if last iteration.
loop.lengthThe number of items in the sequence.
loop.cycleA helper function to cycle between a list of sequences. See the explanation below.
loop.depthIndicates how deep in a recursive loop the rendering currently is. Starts at level 1
loop.depth0Indicates how deep in a recursive loop the rendering currently is. Starts at level 0
loop.previtemThe item from the previous iteration of the loop. Undefined during the first iteration.
loop.nextitemThe item from the following iteration of the loop. Undefined during the last iteration.
loop.changed(*val)True if previously called with a different value (or not called at all).
1prompt #"
2  {% for item in items %}
3    {{ loop.index }}: {{ item }}
4  {% endfor %}
5"#