Constructor
new Capabilities(data)
Creates a new Capabilities object from an API-compatible JSON response.
Parameters:
| Name | Type | Description |
|---|---|---|
data |
object.<string, *> | A capabilities response compatible to the API specification for |
- Source:
Throws:
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
(protected) init()
Initializes the class.
- Source:
isStable() → {boolean}
Is the back-end suitable for use in production?
- Source:
Returns:
true = stable/production, false = unstable
- Type
- boolean
links() → {Array.<Link>}
Returns the links.
- Source:
Returns:
Array of link objects (href, title, rel, type)
- Type
- Array.<Link>
listFeatures() → {Array.<string>}
Lists all supported features.
- Source:
Returns:
An array of supported features.
- Type
- Array.<string>
listFederation() → {Array.<FederationBackend>}
Returns list of backends in the federation.
- Source:
Returns:
Array of backends
- Type
- Array.<FederationBackend>
listPlans() → {Array.<BillingPlan>}
List all billing plans.
- Source:
Returns:
Billing plans
- Type
- Array.<BillingPlan>
(protected) migrate(response) → {AxiosResponse}
Migrates a response, if required.
Parameters:
| Name | Type | Description |
|---|---|---|
response |
AxiosResponse |
- Source:
Returns:
- Type
- AxiosResponse
title() → {string}
Returns the back-end title.
- Source:
Returns:
Title
- Type
- string
toJSON() → {object.<string, *>}
Returns the capabilities response as a JSON serializable representation of the data that is API compliant.
- Source:
Returns:
- A reference to the capabilities response.
- Type
- object.<string, *>
(protected) validate()
Validates the capabilities.
Throws an error in case of an issue, otherwise just passes.
- Source: