Class: OpenEO

OpenEO

Main class to start with openEO. Allows to connect to a server.

Source:

Methods

(static) clientVersion() → {string}

Returns the version number of the client.

Not to confuse with the API version(s) supported by the client.

Source:
Returns:

Version number (according to SemVer).

Type
string

(async, static) connect(url, optionsopt) → {Promise.<Connection>}

Connect to a back-end with version discovery (recommended).

Includes version discovery (request to GET /well-known/openeo) and connects to the most suitable version compatible to this JS client version. Requests the capabilities and authenticates where required.

Parameters:
Name Type Attributes Default Description
url string

The server URL to connect to.
options Options <optional>
 {}

Additional options for the connection.
Source:
Throws:
Error
Returns:
Type
Promise.<Connection>

(async, static) connectDirect(versionedUrl, optionsopt) → {Promise.<Connection>}

Connects directly to a back-end instance, without version discovery (NOT recommended).

Doesn't do version discovery, therefore a URL of a versioned API must be specified. Requests the capabilities and authenticates where required.

Parameters:
Name Type Attributes Default Description
versionedUrl string

The server URL to connect to.
options Options <optional>
 {}

Additional options for the connection.
Source:
Throws:
Error
Returns:
Type
Promise.<Connection>