Class ApiSettings

Settings for API used in composeApi

Constructors

new ApiSettings(nodeHost, reliableNodeHosts?, httpClientOptions?, httpClient?, apiVersion?): ApiSettings
Parameters
- nodeHost: string
  {string} The url of the peer/node
- OptionalreliableNodeHosts: 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.
- OptionalhttpClientOptions: any
  {any} The optional request configuration for the passed Http client
- OptionalhttpClient: Http
  {Http} It's possible to add a custom Http client adapter. Default is an Axios based implementation
- OptionalapiVersion: V1
  {ApiVersion} For future usage. The default implementation uses axios. In case of a custom client pass your own options. see Axios Configuration
Returns ApiSettings
- Defined in packages/core/src/api/composeApi.ts:139

apiVersion?: V1

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

httpClient?: Http

{Http} It's possible to add a custom Http client adapter. Default is an Axios based implementation

httpClientOptions?: any

{any} The optional request configuration for the passed Http client

nodeHost: string

{string} The url of the peer/node

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.