{% if function.parameters %}
Parameter |
Type |
Description |
{% for param in function.parameters %}
{{ param.name }}
{% if param.optional %}
(optional)
{% endif %}
|
{{ param.type }} |
{{ param.desc | markdownify }}
{% if param.type == "function" %}
{% include type-function.md params=param.parameters %}
{% endif %}
{% if param.type == "table" %}
{% include type-table.md fields=param.members %}
{% endif %}
|
{% endfor %}
{% endif %}
{% if function.returns %}
Return value |
Type |
Description |
Returns
{% for return in function.returns %}
{{ return.name }} |
{{ return.type }} |
{{ return.desc | markdownify }} |
{% endfor %}
{% endif %}
{{ function.desc | markdownify | replace: "[icon:attention]","
⚠️" | replace: "[type:string]","
string
" | replace: "[type:number]","
number
" | replace: "[type:table]","
table
" | markdownify}}
{% if function.examples %}
Examples
{% for example in function.examples %}
{{ example.desc | markdownify }}
{% endfor %}
{% endif %}
{% endif %}
{% endfor %}
{% endfor %}