@iota/http-client

Send commands to IRI over HTTP.

Stats

StarsIssuesVersionUpdatedCreatedSize
@iota/http-client
94501.0.0-beta.30a year ago3 years agoMinified + gzip package size for @iota/http-client in KB

Readme

@iota/http-client

Sends commands to IRI over HTTP. Allows to create a network provider compatible with functions in @iota/core.

Installation

Install using npm:

npm install @iota/http-client

or using yarn:

yarn add @iota/http-client

API Reference

http-client.createHttpClient([settings])

Summary: Creates an HTTP client to access the IRI API.

Param Type Default Description
[settings] Object {}
[settings.provider] String http://localhost:14265 URI of an IRI node to connect to
[settings.apiVersion] String | number 1 IOTA API version to be sent in the X-IOTA-API-Version header.
[settings.requestBatchSize] number 1000 Number of search values per request

This method creates an HTTP client that you can use to send requests to the IRI API endpoints.

Related methods

To send requests to the IRI node, use the send() method.

Returns: HTTP client object
Example

let settings = {
 provider: 'http://mynode.eu:14265'
}

let httpClient = HttpClient.createHttpClient(settings);

http-client.send(command, [uri], [apiVersion])

Fulil: Object - Response
Reject: Error - Request error

Param Type Default
command Command
[uri] String http://localhost:14265
[apiVersion] String | Number 1

Sends an http request to a specified host.

Returns: Promise

http-client~createHttpClient(command)

Summary: Sends an API request to the connected IRI node.
Fulfil: Object response - The response from the IRI node
Reject: Object error - The connected IOTA node's API returned an error. See the list of error messages

Param Type Description
command Object The request body for the API endpoint

This method uses the HTTP client to send requests to the IRI API endpoints.

Related methods

To create an HTTP client, use the createHttpClient() method.

Example

let httpClient = HttpClient.createHttpClient(settings);
httpClient.send({command:'getNodeInfo'})
.then(response => {
  console.log(response);
})
.catch(error => {
  console.log(error);
})

http-client~setSettings([settings])

Summary: Updates the settings of an existing HTTP client.

Param Type Default Description
[settings] Object {}
[settings.provider] String http://localhost:14265 URI of an IRI node to connect to
[settings.apiVersion] String | number 1 IOTA API version to be sent in the X-IOTA-API-Version header.
[settings.requestBatchSize] number 1000 Number of search values per request.

This method updates the settings of an existing HTTP client.

Related methods

To create an HTTP client, use the createHttpClient() method.

Example

let settings = {
  provider: 'https://nodes.devnet.thetangle.org:443'
  }

let httpClient = http.createHttpClient(settings);
httpClient.send({command:'getNodeInfo'}).then(res => {
  console.log(res)
}).catch(err => {
  console.log(err)
});

httpClient.setSettings({provider:'http://newnode.org:14265'});

httpClient.send({command:'getNodeInfo'}).then(res => {
  console.log(res)
}).catch(err => {
  console.log(err)
})

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.