Skip to content

Commit 1a991d8

Browse files
committed
Improved docs.
1 parent 886a128 commit 1a991d8

File tree

4 files changed

+7
-9
lines changed

4 files changed

+7
-9
lines changed

.travis.yml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,7 @@ script:
2020
# Deploy
2121
- git clone --branch gh-pages https://$GITHUB_TOKEN@github.com/Open-EO/openeo-js-client.git gh-pages
2222
- cd gh-pages
23-
- rm -rf $TRAVIS_BRANCH/
24-
- mkdir -p $TRAVIS_BRANCH/
25-
- cp -R ../docs/* $TRAVIS_BRANCH/
23+
- cp -R ../docs/@openeo/js-client/* .
2624

2725
deploy:
2826
provider: pages

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ try {
4040
var con = await OpenEO.connect("https://earthengine.openeo.org", "basic", {username: "group1", password: "test123"});
4141

4242
// Show implemented API version of the back-end
43-
var capabilities = await con.capabilities();
43+
var capabilities = con.capabilities();
4444
console.log("Server API version: " + capabilities.apiVersion());
4545

4646
// List collection names
@@ -56,21 +56,21 @@ try {
5656
console.log("Files types: " + Object.keys(fileTypes.formats));
5757

5858
// Check whether synchronous previews are supported
59-
var syncSupport = capabilities.hasFeature("execute");
59+
var syncSupport = capabilities.hasFeature("computeResult");
6060
console.log("Synchronous previews: " + (syncSupport ? "supported" : "NOT supported"));
6161

6262
// Request a preview synchronously for a process graph
6363
if (syncSupport) {
6464
// Replace ... with your JSON process graph
65-
var preview = await con.execute(..., "png");
65+
var preview = await con.computeResult(..., "png");
6666
// This returns a Blob object containing a binary PNG file you could further process or show.
6767
}
6868
} catch(e) {
6969
console.log(e);
7070
}
7171
```
7272

73-
More information can be found in the [**JS client documentation**](https://open-eo.github.io/openeo-js-client/development/).
73+
More information can be found in the [**JS client documentation**](https://open-eo.github.io/openeo-js-client/0.4.0-beta.1/).
7474

7575
## Interactive JS Editor
7676

openeo.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1454,7 +1454,7 @@ class ProcessGraph extends BaseEntity {
14541454
* Creates an object representing a process graph stored at the back-end.
14551455
*
14561456
* @param {Connection} connection - A Connection object representing an established connection to an openEO back-end.
1457-
* @param {*} processGraphId
1457+
* @param {string} processGraphId - ID of a stored process graph.
14581458
* @constructor
14591459
*/
14601460
constructor(connection, processGraphId) {

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
"ws": "^6.2.1"
3838
},
3939
"scripts": {
40-
"docs": "jsdoc openeo.js -d docs/",
40+
"docs": "jsdoc openeo.js -d docs/ -P package.json -R README.md",
4141
"build": "minify openeo.js --out-file openeo.min.js --mangle.keepClassName -d lib",
4242
"test": "jest basic.test.js --env=jsdom",
4343
"test_node": "jest basic.test.js --env=node",

0 commit comments

Comments
 (0)