Skip to content

Commit c3f7957

Browse files
Merge pull request #464 from appwrite/fix-websdk-examples
Fix: Web SDK README
2 parents dfe67ab + bdd94da commit c3f7957

File tree

3 files changed

+11
-7
lines changed

3 files changed

+11
-7
lines changed

templates/node/docs/example.md.twig

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ const fs = require('fs');
44
{% endif %}
55

66
// Init SDK
7-
let client = new sdk.Client();
7+
const client = new sdk.Client();
88

9-
let {{ service.name | caseCamel }} = new sdk.{{service.name | caseUcfirst}}(client);
9+
const {{ service.name | caseCamel }} = new sdk.{{service.name | caseUcfirst}}(client);
1010

1111
{% if method.security|length > 0 %}
1212
client
@@ -18,7 +18,7 @@ client
1818
{% endfor %};
1919

2020
{% endif %}
21-
let promise = {{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% for parameter in method.parameters.all %}{% if parameter.required %}{% if not loop.first %}, {% endif %}{{ parameter | paramExample }}{% endif %}{% endfor %});
21+
const promise = {{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% for parameter in method.parameters.all %}{% if parameter.required %}{% if not loop.first %}, {% endif %}{{ parameter | paramExample }}{% endif %}{% endfor %});
2222

2323
promise.then(function (response) {
2424
console.log(response);

templates/web/README.md.twig

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ npm install {{ language.params.npmPackage }} --save
3333
If you're using a bundler (like [Rollup](https://rollupjs.org/) or [webpack](https://webpack.js.org/)), you can import the {{ spec.title }} module when you need it:
3434

3535
```js
36-
import {{ '{' }} {{ language.params.npmPackage|caseUcfirst }} {{ '}' }} from "{{ language.params.npmPackage }}";
36+
import {{ '{' }} Client, Account {{ '}' }} from "{{ language.params.npmPackage }}";
3737
```
3838

3939
### CDN

templates/web/docs/example.md.twig

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
1-
const sdk = new {{ spec.title | caseUcfirst }}();
1+
import {{ '{' }} Client, {{service.name | caseUcfirst}} {{ '}' }} from "{{ language.params.npmPackage }}";
2+
3+
const client = new Client();
4+
5+
const {{ service.name | caseCamel }} = new {{service.name | caseUcfirst}}(client);
26

37
{% if method.security|length > 0 %}
4-
sdk
8+
client
59
.setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
610
{% for node in method.security %}
711
{% for key,header in node|keys %}
@@ -12,7 +16,7 @@ sdk
1216
{% endif %}
1317
{% if method.type == 'webAuth' %}// Go to OAuth provider login page
1418
{% endif %}
15-
{% if method.type == 'webAuth' %}{% elseif method.type == 'location' %}let result = {% else %}let promise = {% endif %}sdk.{{ service.name | caseLower }}.{{ method.name | caseCamel }}({% for parameter in method.parameters.all %}{% if parameter.required %}{% if not loop.first %}, {% endif %}{{ parameter | paramExample }}{% endif %}{% endfor %});
19+
{% if method.type == 'webAuth' %}{% elseif method.type == 'location' %}const result = {% else %}const promise = {% endif %}{{ service.name | caseCamel }}.{{ method.name | caseCamel }}({% for parameter in method.parameters.all %}{% if parameter.required %}{% if not loop.first %}, {% endif %}{{ parameter | paramExample }}{% endif %}{% endfor %});
1620

1721
{% if method.type == 'webAuth' %}{% elseif method.type == 'location' %}console.log(result); // Resource URL{% else %}promise.then(function (response) {
1822
console.log(response); // Success

0 commit comments

Comments
 (0)