Skip to content

Commit e5760ef

Browse files
authored
Merge pull request #1155 from appwrite/feat-object-style-examples
Use object style params for examples
2 parents 8f16ba8 + bbd0751 commit e5760ef

File tree

4 files changed

+23
-24
lines changed

4 files changed

+23
-24
lines changed

templates/deno/docs/example.md.twig

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,11 @@ const client = new Client()
1212

1313
const {{ service.name | caseCamel }} = new {{service.name | caseUcfirst}}(client{% if service.globalParams | length %}{% for parameter in service.globalParams %}, {{ parameter | paramExample }}{% endfor %}{% endif %});
1414

15-
{% if method.type == 'location' %}const result = {% elseif method.type != 'webAuth' %}const response = await {% endif -%}
16-
{{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% if method.parameters.all | length == 0 %});{% endif %}
17-
15+
{% if method.type == 'location' %}const result = {% elseif method.type != 'webAuth' %}const response = await {% endif %}{{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% if method.parameters.all | length == 0 %});
16+
{% else %}{
1817
{%~ for parameter in method.parameters.all %}
19-
{% if parameter.enumValues | length > 0 %}{{ parameter.enumName }}.{{ (parameter.enumKeys[0] ?? parameter.enumValues[0]) | caseEnumKey }}{% else%}{{ parameter | paramExample }}{% endif %}{% if not loop.last %},{% endif %} // {{ parameter.name }}{% if not parameter.required %} (optional){% endif %}
18+
{{ parameter.name | caseCamel }}: {% if parameter.enumValues | length > 0 %}{{ parameter.enumName }}.{{ (parameter.enumKeys[0] ?? parameter.enumValues[0]) | caseEnumKey }}{% else%}{{ parameter | paramExample }}{% endif %}{% if not loop.last %},{% endif %}
2019

21-
{%~ endfor %}
22-
{% if method.parameters.all | length > 0 %});
20+
{%~ endfor -%}
21+
});
2322
{% endif %}

templates/node/docs/example.md.twig

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@ const client = new sdk.Client()
1515

1616
const {{ service.name | caseCamel }} = new sdk.{{service.name | caseUcfirst}}(client);
1717

18-
const result = await {{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% if method.parameters.all | length == 0 %});{% endif %}
18+
const result = await {{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% if method.parameters.all | length == 0 %});
19+
{% else %}{
20+
{%~ for parameter in method.parameters.all %}
21+
{{ parameter.name | caseCamel }}: {% if parameter.enumValues | length > 0%}sdk.{{ parameter.enumName }}.{{(parameter.enumKeys[0] ?? parameter.enumValues[0]) | caseEnumKey }}{% else %}{{ parameter | paramExample}}{% endif %}{% if not loop.last %},{% endif%}
1922

20-
{%~ for parameter in method.parameters.all %}
21-
{% if parameter.enumValues | length > 0%}sdk.{{ parameter.enumName }}.{{(parameter.enumKeys[0] ?? parameter.enumValues[0]) | caseEnumKey }}{% else %}{{ parameter | paramExample}}{% endif %}{% if not loop.last %},{% endif%} // {{ parameter.name }}{% if not parameter.required %} (optional){% endif %}
22-
23-
{%~ endfor -%}
24-
{% if method.parameters.all | length > 0 %});
23+
{%~ endfor -%}
24+
});
2525
{% endif %}

templates/react-native/docs/example.md.twig

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@ const client = new Client()
1212

1313
const {{ service.name | caseCamel }} = new {{service.name | caseUcfirst}}(client{% if service.globalParams | length %}{% for parameter in service.globalParams %}, {{ parameter | paramExample }}{% endfor %}{% endif %});
1414

15-
{% if method.type == 'location' %}const result = {% elseif method.type != 'webAuth' %}const result = await {% endif %}{{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% if method.parameters.all | length == 0 %});{% endif %}
15+
{% if method.type == 'location' %}const result = {% elseif method.type != 'webAuth' %}const result = await {% endif %}{{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% if method.parameters.all | length == 0 %});
16+
{% else %}{
17+
{%~ for parameter in method.parameters.all %}
18+
{{ parameter.name | caseCamel }}: {% if parameter.enumValues | length > 0 %}{{ parameter.enumName }}.{{ (parameter.enumKeys[0] ?? parameter.enumValues[0]) | caseEnumKey }}{% else%}{{ parameter | paramExample }}{% endif %}{% if not loop.last %},{% endif %}
1619

17-
{%~ for parameter in method.parameters.all %}
18-
{% if parameter.enumValues | length > 0 %}{{ parameter.enumName }}.{{ (parameter.enumKeys[0] ?? parameter.enumValues[0]) | caseEnumKey }}{% else%}{{ parameter | paramExample }}{% endif %}{% if not loop.last %},{% endif %} // {{ parameter.name }}{% if not parameter.required %} (optional){% endif %}
19-
20-
{%~ endfor %}
21-
{% if method.parameters.all | length > 0 %});
20+
{%~ endfor -%}
21+
});
2222
{% endif %}
2323

2424
{% if method.type != 'webAuth' %}

templates/web/docs/example.md.twig

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@ const client = new Client()
1212

1313
const {{ service.name | caseCamel }} = new {{service.name | caseUcfirst}}(client{% if service.globalParams | length %}{% for parameter in service.globalParams %}, {{ parameter | paramExample }}{% endfor %}{% endif %});
1414

15-
{% if method.type == 'location' %}const result = {% elseif method.type != 'webAuth' %}const result = await {% endif %}{{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% if method.parameters.all | length == 0 %});{% endif %}
15+
{% if method.type == 'location' %}const result = {% elseif method.type != 'webAuth' %}const result = await {% endif %}{{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% if method.parameters.all | length == 0 %});
16+
{% else %}{
17+
{%~ for parameter in method.parameters.all %}
18+
{{ parameter.name | caseCamel }}: {% if parameter.enumValues | length > 0 %}{{ parameter.enumName }}.{{ (parameter.enumKeys[0] ?? parameter.enumValues[0]) | caseEnumKey }}{% else%}{{ parameter | paramExample }}{% endif %}{% if not loop.last %},{% endif %}
1619

17-
{%~ for parameter in method.parameters.all %}
18-
{% if parameter.enumValues | length > 0 %}{{ parameter.enumName }}.{{ (parameter.enumKeys[0] ?? parameter.enumValues[0]) | caseEnumKey }}{% else%}{{ parameter | paramExample }}{% endif %}{% if not loop.last %},{% endif %} // {{ parameter.name }}{% if not parameter.required %} (optional){% endif %}
19-
20-
{%~ endfor %}
21-
{% if method.parameters.all | length > 0 %});
20+
{%~ endfor -%}
21+
});
2222
{% endif %}
2323

2424
{% if method.type != 'webAuth' %}

0 commit comments

Comments
 (0)