Eve Swagger JS

Class: Regions

Regions

An api adapter over the end points handling regions via functions in the universe and search ESI endpoints. You should not usually instantiate this directly as its constructor requires an internal api instance.

This is a function class so instances of Regions are functions and can be invoked directly, besides accessing its members. Its default function action is equivalent to get or to all if no id is provided.

new Regions(agent)

Create a new Regions function using the given agent.

Parameters:
Name Type Description
agent ESIAgent

The ESI agent

Members

A Search module instance configured to search over the 'region' type.

Type:

Methods

all()

Get a list of regions. This route expires daily at 11:05.

This makes an HTTP GET request to /universe/regions/. The route version is v1.

On success, this resolves to a list of region ids.

Returns:

A Promise that resolves to the parsed JSON of the response.

Type
Promise.<Array.<Number>>

get(id)

Create a new Region end point targeting the particular region by id.

Parameters:
Name Type Description
id Number

The region id
Returns:
Type
Region

names(ids)

Resolve a set of IDs to names and categories. Supported ID's for resolving are: Characters, Corporations, Alliances, Stations, Solar Systems, Constellations, Regions, Types.

This makes an HTTP POST request to /universe/names/. The route version is v2.

The array length of ids must be between 1 and 1000.

On success, this resolves to list of id/name associations for a set of ID's. ID's that cannot be resolved are not returned. An example result is:

[
  {
    "id": 95465499,
    "name": "CCP Bartender"
  }
]

Note that the type schema of the response is modified from what is defined in ESI. Specifically:

  • The category property is removed.

Results will only include matches with the region category. If ids is longer than the reported maximum length for ESI, the array will be split into smaller chunks and multiple requests will be made and then concatenated back together.

Parameters:
Name Type Description
ids Array.<Number>

The ids to resolve. If no ids are provided, then all names are returned.
Returns:

A Promise that resolves to the parsed JSON of the response.

Type
Promise.<Array.<Object>>