JsonApiServer

JsonApiServer

Base class for services following the JSON API spec.

Constructor

new JsonApiServer(sdk, serverUrl, opts)

Create a new Horizon instance.

Source:
Parameters:
Name Type Description
sdk ShelfNetwork

Parent SDK instance.

serverUrl string

Horizon server instance URL.

opts Object
Name Type Attributes Description
alias string <optional>

Service alias used by the API gateway.

allowHttp boolean <optional>

Allow connecting to http servers, default: false. This must be set to false in production deployments!

proxy Object <optional>

Proxy configuration. Look axios docs for more info

httpBasicAuth Object <optional>

HTTP basic auth credentials. Look axios docs for more info.

customHeaders Object <optional>

Custom headers for request.

Classes

JsonApiServer

Methods

ejectRequestInterceptor(interceptor)

Eject request interceptor.

Source:
See:
Parameters:
Name Type Description
interceptor Object

Axios.js interceptor descriptor.

ejectResponseInterceptor(interceptor)

Eject response interceptor.

Source:
See:
Parameters:
Name Type Description
interceptor Object

Axios.js interceptor descriptor.

getResourceUrl(urlSegments, query) → {string}

Get url for current resource

Source:
Parameters:
Name Type Description
urlSegments Array.<string>

URL path segments to be added to the base server URL.

query object

URL query.

Returns:
Type:
string

useRequestInterceptor(handleSuccess, handleFailure) → {Object}

Use request interceptor.

Source:
See:
Parameters:
Name Type Description
handleSuccess function

Handler for successful requests.

handleFailure function

Handler for failed requests.

Returns:
Type:
Object

Axios.js interceptor object.

useResponseInterceptor(handleSuccess, handleFailure) → {Object}

Use response interceptor.

Source:
See:
Parameters:
Name Type Description
handleSuccess function

Handler for successful responses.

handleFailure function

Handler for failed responses.

Returns:
Type:
Object

Axios.js interceptor object.