IAP-Extension-Mirror/docs/index.md

layout

layout
default

Modules

{% for item in site.data.api %}

{{ item.name }}

{% include description.md desc=item.desc %} {% endfor %}

---

Enums

{% for module in site.data.api %} {% for item in module.members %} {% if item.type contains 'number' %}

    {% endif %}
{% endfor %}

{% endfor %}

{{ module.name }}.{{ item.name }}

{{ item.desc | markdownify | replace: "[icon:attention]"," ⚠️"}}

---

Functions

{% for module in site.data.api %} {% for item in module.members %} {% if item.type contains 'function' %} {% endif %} {% endfor %} {% endfor %}

{{ module.name }}.{{ item.name }}()

{% include description.md desc=item.desc %}

{% for module in site.data.api %} {% for function in module.members %} {% if function.type contains 'function' %}

{{ module.name }}.{{ function.name }}({% for param in function.parameters %}{{param.name}}{% unless forloop.last %}, {% endunless %}{% endfor %})

{% include description.md desc=function.desc %} {% if function.parameters %} {% for param in function.parameters %} {% endfor %}

Parameter	Type	Description
{{ param.name }} {% if param.optional %} (optional) {% endif %}	{{ param.type }}	{% include description.md desc=param.desc %} {% if param.type == "function" %} {% include type-function.md params=param.parameters %} {% endif %} {% if param.type == "table" %} {% include type-table.md fields=param.members %} {% endif %}

{% endif %} {% if function.returns %}

Returns

{% for return in function.returns %} {% endfor %}

Return value	Type	Description
{{ return.name }}	{{ return.type }}	{% include description.md desc=return.desc %} {% if return.type == "table" %} {% include type-table.md fields=return.members %} {% endif %}

{% endif %}

{% if function.examples %}

Examples

{% for example in function.examples %} {{ example.desc | markdownify }} {% endfor %} {% endif %}

    {% endif %}
{% endfor %}

{% endfor %}