Class StreamingSwapApi

StreamingSwapApi - object-oriented interface

Export

StreamingSwapApi

Hierarchy

BaseAPI
- StreamingSwapApi

Index

Constructors

Properties

axios basePath configuration

Methods

streamSwap streamSwaps

Constructors

constructor

new StreamingSwapApi(configuration?, basePath?, axios?): StreamingSwapApi
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns StreamingSwapApi
Inherited from BaseAPI.constructor
- Defined in xchainjs-lib/packages/xchain-thornode/src/generated/thornodeApi/base.ts:52

Properties

`Protected` axios

axios: AxiosInstance = globalAxios

`Protected` basePath

basePath: string = BASE_PATH

`Protected` configuration

configuration: undefined | Configuration

Methods

streamSwap

streamSwap(hash, height?, options?): Promise<AxiosResponse<StreamingSwap, any>>
Returns the state of a streaming swap
Parameters
- hash: string
- Optional height: number
  optional block height, defaults to current tip
- Optional options: AxiosRequestConfig<any>
  Override http request option.
Returns Promise<AxiosResponse<StreamingSwap, any>>
Throws
Memberof
StreamingSwapApi
- Defined in xchainjs-lib/packages/xchain-thornode/src/generated/thornodeApi/api.ts:7501

streamSwaps

streamSwaps(height?, options?): Promise<AxiosResponse<StreamingSwapsResponse, any>>
Returns the state of all streaming swaps
Parameters
- Optional height: number
  optional block height, defaults to current tip
- Optional options: AxiosRequestConfig<any>
  Override http request option.
Returns Promise<AxiosResponse<StreamingSwapsResponse, any>>
Throws
Memberof
StreamingSwapApi
- Defined in xchainjs-lib/packages/xchain-thornode/src/generated/thornodeApi/api.ts:7512

Generated using TypeDoc