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.
withCredentials boolean <optional>

Indicates whether or not cross-site Access-Control requests should be made using credentials.

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.

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.