Class QueueApi

QueueApi - object-oriented interface

Export

QueueApi

Hierarchy

BaseAPI
- QueueApi

Index

Constructors

Properties

axios basePath configuration

Methods

queue queueOutbound queueScheduled queueSwap

Constructors

constructor

new QueueApi(configuration?, basePath?, axios?): QueueApi
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns QueueApi
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

queue

queue(height?, options?): Promise<AxiosResponse<QueueResponse, any>>
Returns queue statistics.
Parameters
- Optional height: number
  optional block height, defaults to current tip
- Optional options: AxiosRequestConfig<any>
  Override http request option.
Returns Promise<AxiosResponse<QueueResponse, any>>
Throws
Memberof
QueueApi
- Defined in xchainjs-lib/packages/xchain-thornode/src/generated/thornodeApi/api.ts:6545

queueOutbound

queueOutbound(height?, options?): Promise<AxiosResponse<OutboundResponse, any>>
Returns the outbound queue including estimated RUNE values.
Parameters
- Optional height: number
  optional block height, defaults to current tip
- Optional options: AxiosRequestConfig<any>
  Override http request option.
Returns Promise<AxiosResponse<OutboundResponse, any>>
Throws
Memberof
QueueApi
- Defined in xchainjs-lib/packages/xchain-thornode/src/generated/thornodeApi/api.ts:6556

queueScheduled

queueScheduled(height?, options?): Promise<AxiosResponse<ScheduledResponse, any>>
Returns the scheduled queue.
Parameters
- Optional height: number
  optional block height, defaults to current tip
- Optional options: AxiosRequestConfig<any>
  Override http request option.
Returns Promise<AxiosResponse<ScheduledResponse, any>>
Throws
Memberof
QueueApi
- Defined in xchainjs-lib/packages/xchain-thornode/src/generated/thornodeApi/api.ts:6567

queueSwap

queueSwap(height?, options?): Promise<AxiosResponse<SwapQueueResponse, any>>
Returns the swap queue.
Parameters
- Optional height: number
  optional block height, defaults to current tip
- Optional options: AxiosRequestConfig<any>
  Override http request option.
Returns Promise<AxiosResponse<SwapQueueResponse, any>>
Throws
Memberof
QueueApi
- Defined in xchainjs-lib/packages/xchain-thornode/src/generated/thornodeApi/api.ts:6578

Generated using TypeDoc