esi-little-helper

This module provides a simple way to execute calls towards ESI, the EVE Online API, handling automatically API error limits and pagination.

It's built on top of the javascript's Fetch API, so for more details on the returned Response and Headers objects please refer to the Fetch documentation.

Disclaimer: this module has no built in throttling, so in case of pagination all the requests to get the remining pages will be dispatched at the same time with a single call.

---

CallBuilder

An helper class to compose the parameters for the ESI call.

let params = new CallBuilder(
    method,   // required (ex. 'GET')
    path,     // required (ex. '/v4/universe/systems/30000142/')
    token,    // optional, depending on the API endpoint
    body      // optional, depending on the API endpoint
);

Esi

Execute the call using the Esi's call method, if pagination is detected it calls automatically all the pages, throw in case of API error, or in case the ESI object has broken the error limit and it's still within the same error window.
Returns a Result object.

Ideally a single instance of the Esi class should be used for all the calls, to better keep track of API errors and share the same error window information.

let esi = new Esi('my user agent');
result = esi.call(params);

Result

Get the JSON of the API call, in case of pagination the bodies are merged together in a single JSON.

result.json()
    .then(data => console.log(data))
    .catch(e => console.error(e));

Get the Headers object of the response, in case of paginated call returns the Headers object of the first response.

result.headers()
    .then(data => console.log(data))
    .catch(e => console.error(e));

Get the Response object of the response, in case of paginated call returns the first response.

result.response()
    .then(data => console.log(data))
    .catch(e => console.error(e));

---

Example

First initialize the Esi class and create the specific parameter object containing the necessary properties, such as method and path.

let esi = new Esi('my app name');
let params = new CallBuilder(
    'GET',
    '/v4/universe/systems/30000142/'
);

Then execute the calling the Esi call() method passing to it the parameter object created previously.

The call method return a Result object, from which you can access the resulting json as soon as the response (or all the responses, in case of pagination) is resolved.

esi.call(params).json()
  .then(data => console.log(data.name))
  .catch(e => console.error(e));
 
// -> Jita