Class InvariantsApi

InvariantsApi - object-oriented interface

Export

InvariantsApi

Hierarchy

BaseAPI
- InvariantsApi

Index

Constructors

Properties

axios basePath configuration

Methods

invariant invariants

Constructors

constructor

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

invariant

invariant(invariant, height?, options?): Promise<AxiosResponse<InvariantResponse, any>>
Returns result of running the given invariant.
Parameters
- invariant: string
- Optional height: number
  optional block height, defaults to current tip
- Optional options: AxiosRequestConfig<any>
  Override http request option.
Returns Promise<AxiosResponse<InvariantResponse, any>>
Throws
Memberof
InvariantsApi
- Defined in xchainjs-lib/packages/xchain-thornode/src/generated/thornodeApi/api.ts:4439

invariants

invariants(height?, options?): Promise<AxiosResponse<InvariantsResponse, any>>
Returns a list of available invariants.
Parameters
- Optional height: number
  optional block height, defaults to current tip
- Optional options: AxiosRequestConfig<any>
  Override http request option.
Returns Promise<AxiosResponse<InvariantsResponse, any>>
Throws
Memberof
InvariantsApi
- Defined in xchainjs-lib/packages/xchain-thornode/src/generated/thornodeApi/api.ts:4450

Generated using TypeDoc