Class: DataONEHttpClient

DataONEHttpClient()

Generic HTTP client for DataONE APIs. Handles auth headers, retries with backoff, optional in-flight deduplication, abort support, normalized responses/errors, and timeouts. It does not know about app models or TTLs; it only handles transport concerns.

Constructor

new DataONEHttpClient()

Since:
  • 2.37.0
Source:

Methods

request(options) → {Promise.<DataONEHttpResponse>}

Perform an HTTP request.
Parameters:
Name Type Description
options DataONEHttpRequestOptions Request options
Source:
Returns:
A promise that resolves to a normalized response object.
Type
Promise.<DataONEHttpResponse>

buildInstanceKey(optionsopt) → {string}

Build a unique instance key based on client options.
Parameters:
Name Type Attributes Description
options DataONEHttpClientOptions <optional>
 Client configuration
Source:
Returns:
Instance key
Type
string

get(optionsopt) → {DataONEHttpClient}

Get a singleton DataONEHttpClient instance for the provided options.
Parameters:
Name Type Attributes Description
options DataONEHttpClientOptions <optional>
 Client configuration
Source:
Returns:
Client instance
Type
DataONEHttpClient

normalizeOptions(optionsopt) → {object}

Normalize options for instance keys and default values.
Parameters:
Name Type Attributes Description
options DataONEHttpClientOptions <optional>
 Client configuration
Source:
Returns:
Normalized options
Type
object

DataONEHttpClient(optionsopt)

new DataONEHttpClient(optionsopt)

Parameters:
Name Type Attributes Description
options DataONEHttpClientOptions <optional>
 Client configuration
Source:

Methods

request(options) → {Promise.<DataONEHttpResponse>}

Perform an HTTP request.
Parameters:
Name Type Description
options DataONEHttpRequestOptions Request options
Source:
Returns:
A promise that resolves to a normalized response object.
Type
Promise.<DataONEHttpResponse>

buildInstanceKey(optionsopt) → {string}

Build a unique instance key based on client options.
Parameters:
Name Type Attributes Description
options DataONEHttpClientOptions <optional>
 Client configuration
Source:
Returns:
Instance key
Type
string

get(optionsopt) → {DataONEHttpClient}

Get a singleton DataONEHttpClient instance for the provided options.
Parameters:
Name Type Attributes Description
options DataONEHttpClientOptions <optional>
 Client configuration
Source:
Returns:
Client instance
Type
DataONEHttpClient

normalizeOptions(optionsopt) → {object}

Normalize options for instance keys and default values.
Parameters:
Name Type Attributes Description
options DataONEHttpClientOptions <optional>
 Client configuration
Source:
Returns:
Normalized options
Type
object