Eve Swagger JS

Class: Groups

Groups

An api adapter that provides functions for accessing item group information via the universe ESI end points. You should not usually instantiate this directly as its constructor requires an internal api instance.

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

new Groups(agent)

Create a new Groups instance using the given agent.

Parameters:
Name Type Description
agent ESIAgent

The ESI agent

Methods

all(page)

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

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

page must be at least 1.

On success, this resolves to a list of item group ids.

Parameters:
Name Type Default Description
page Number 0

Which page to query. If 0, then all pages are returned concatenated into a single array.
Returns:

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

Type
Promise.<Array.<Number>>

get(id)

Create a new Group end point targeting the particular group by id.

Parameters:
Name Type Description
id Number

The group id
Returns:
Type
Group