Class MayanamesApi

MayanamesApi - object-oriented interface

Export

MayanamesApi

Hierarchy

BaseAPI
- MayanamesApi

Index

Constructors

Properties

axios basePath configuration

Methods

Constructors

constructor

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

Properties

`Protected` axios

axios: AxiosInstance = globalAxios

`Protected` basePath

basePath: string = BASE_PATH

`Protected` configuration

configuration: undefined | Configuration

Methods

mayaname

mayaname(name, height?, options?): Promise<AxiosResponse<MayanameResponse, any>>
Returns addresses registered to the provided mayaname.
Parameters
- name: string
  the mayanode to lookup
- Optional height: number
  optional block height, defaults to current tip
- Optional options: AxiosRequestConfig<any>
  Override http request option.
Returns Promise<AxiosResponse<MayanameResponse, any>>
Throws
Memberof
MayanamesApi
- Defined in xchainjs-lib/packages/xchain-mayanode/src/generated/mayanodeApi/api.ts:2432

Generated using TypeDoc