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
|
|
Classes
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.