Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ApiSettings

Settings for API used in composeApi

Hierarchy

  • ApiSettings

Index

Constructors

constructor

  • new ApiSettings(nodeHost: string, reliableNodeHosts?: string[], httpClientOptions?: any | AxiosRequestConfig, apiVersion?: ApiVersion): ApiSettings
  • Parameters

    • nodeHost: string

      The url of the peer/node

    • Optional reliableNodeHosts: string[]

      A list of node/peer hosts that can be chosen of, usually a list of reliable/trusted nodes. This is necessary for the automatic node selection.

    • Optional httpClientOptions: any | AxiosRequestConfig

      Optional http options, like additional header.

    • Optional apiVersion: ApiVersion

      For future usage. The default implementation uses axios. In case of a custom client pass your own options. see Axios Configuration

    Returns ApiSettings

Properties

Optional apiVersion

apiVersion: ApiVersion

For future usage. The default implementation uses axios. In case of a custom client pass your own options. see Axios Configuration

Optional httpClientOptions

httpClientOptions: any | AxiosRequestConfig

Optional http options, like additional header.

nodeHost

nodeHost: string

The url of the peer/node

Optional reliableNodeHosts

reliableNodeHosts: string[]

A list of node/peer hosts that can be chosen of, usually a list of reliable/trusted nodes. This is necessary for the automatic node selection.