Class: Capabilities

Capabilities(data)

Capabilities of a back-end.

Constructor

new Capabilities(data)

Creates a new Capabilities object from an API-compatible JSON response.
Parameters:
Name Type Description
data object A capabilities response compatible to the API specification.
Source:
Throws:
Error

Methods

apiVersion() → {string}

Returns the openEO API version implemented by the back-end.
Source:
Returns:
openEO API version number.
Type
string

backendVersion() → {string}

Returns the back-end version number.
Source:
Returns:
openEO back-end version number.
Type
string

currency() → {string|null}

Get the billing currency.
Source:
Returns:
The billing currency or `null` if not available.
Type
string | null

description() → {string}

Returns the back-end description.
Source:
Returns:
Description
Type
string

hasFeature(methodName) → {boolean}

Check whether a feature is supported by the back-end.
Parameters:
Name Type Description
methodName string A feature name (corresponds to the JS client method names, see also the feature map for allowed values).
Source:
Returns:
`true` if the feature is supported, otherwise `false`.
Type
boolean

listFeatures() → {Array.<string>}

Lists all supported features.
Source:
Returns:
An array of supported features.
Type
Array.<string>

listPlans() → {Array.<BillingPlan>}

List all billing plans.
Source:
Returns:
Billing plans
Type
Array.<BillingPlan>

title() → {string}

Returns the back-end title.
Source:
Returns:
Title
Type
string

toPlainObject() → {object}

Returns the capabilities response as a plain object.
Source:
Returns:
- A reference to the capabilities response.
Type
object