Class AllianceClient

The base of the custom domain clients: an endpoint map turned into methods, plus the stream*/fetchAll* page helpers and withMetadata/withSafeMode. Extend it for a custom domain client of your own.

Hierarchy (View Summary)

BaseEsiClient<typeof allianceEndpoints>
- AllianceClient

Index

Constructors

constructor

new AllianceClient(client: ApiClient): AllianceClient
Parameters
- client: ApiClient
Returns AllianceClient
Overrides BaseEsiClient.constructor
- Defined in src/clients/AllianceClient.ts:18

Properties

`Protected`api

api: ClientMethods<T>

`Protected`_client

_client: ApiClient

`Protected`_endpoints

_endpoints: {
    getAllianceById: {
        path: "alliances/{allianceId}/";
        method: "GET";
        requiresAuth: false;
        pathParams: readonly ["allianceId"];
        responseSchema: ZodObject<
            {
                alliance_id: ZodOptional<ZodNumber>;
                name: ZodString;
                ticker: ZodString;
                creator_id: ZodNumber;
                creator_corporation_id: ZodNumber;
                executor_corporation_id: ZodOptional<ZodNumber>;
                date_founded: ZodString;
                faction_id: ZodOptional<ZodNumber>;
            },
            $loose,
        >;
    };
    getCorporations: {
        path: "alliances/{allianceId}/corporations/";
        method: "GET";
        requiresAuth: false;
        pathParams: readonly ["allianceId"];
        responseSchema: ZodArray<ZodNumber>;
    };
    getIcons: {
        path: "alliances/{allianceId}/icons/";
        method: "GET";
        requiresAuth: false;
        pathParams: readonly ["allianceId"];
        responseSchema: ZodObject<
            { px64x64: ZodOptional<ZodString>; px128x128: ZodOptional<ZodString> },
            $loose,
        >;
    };
    getAlliances: {
        path: "alliances";
        method: "GET";
        requiresAuth: false;
        responseSchema: ZodArray<ZodNumber>;
    };
}

Methods

getAllianceById

getAllianceById(
    allianceId: number,
): Promise<
    {
        alliance_id?: number;
        name: string;
        ticker: string;
        creator_id: number;
        creator_corporation_id: number;
        executor_corporation_id?: number;
        date_founded: string;
        faction_id?: number;
        [key: string]: unknown;
    },
>
Retrieve public information about an alliance.
Parameters
- allianceId: number
  The ID of the alliance to look up
Returns Promise<
    {
        alliance_id?: number;
        name: string;
        ticker: string;
        creator_id: number;
        creator_corporation_id: number;
        executor_corporation_id?: number;
        date_founded: string;
        faction_id?: number;
        [key: string]: unknown;
    },
>
Public alliance information including name, ticker, and founding date
- Defined in src/clients/AllianceClient.ts:29

getContacts

getContacts(
    allianceId: number,
): Promise<
    {
        contact_id: number;
        contact_type: string & {}
        | "character"
        | "corporation"
        | "alliance";
        standing: number;
        label_ids?: number[];
        [key: string]: unknown;
    }[],
>
Retrieve contacts for an alliance.
Parameters
- allianceId: number
  The ID of the alliance whose contacts to retrieve
Returns Promise<
    {
        contact_id: number;
        contact_type: string & {}
        | "character"
        | "corporation"
        | "alliance";
        standing: number;
        label_ids?: number[];
        [key: string]: unknown;
    }[],
>
A list of alliance contacts with standings and contact types

Deprecated
Use ContactsClient.getAllianceContacts() instead

Requires
Authentication
- Defined in src/clients/AllianceClient.ts:41

getContactLabels

getContactLabels(
allianceId: number,
): Promise<
{ label_id: number; label_name: string; [key: string]: unknown }[],
>
Retrieve custom contact labels for an alliance.
Parameters
- allianceId: number
  The ID of the alliance whose contact labels to retrieve
Returns Promise<{ label_id: number; label_name: string; [key: string]: unknown }[]>
A list of custom labels used to categorize alliance contacts

Deprecated
Use ContactsClient.getAllianceContactLabels() instead

Requires
Authentication
- Defined in src/clients/AllianceClient.ts:60

getCorporations

getCorporations(allianceId: number): Promise<number[]>
Retrieve the list of corporation IDs that are members of an alliance.
Parameters
- allianceId: number
  The ID of the alliance whose member corporations to retrieve
Returns Promise<number[]>
An array of corporation IDs belonging to the alliance
- Defined in src/clients/AllianceClient.ts:77

getIcons

getIcons(
allianceId: number,
): Promise<{ px64x64?: string; px128x128?: string; [key: string]: unknown }>
Retrieve icon URLs for an alliance.
Parameters
- allianceId: number
  The ID of the alliance whose icons to retrieve
Returns Promise<{ px64x64?: string; px128x128?: string; [key: string]: unknown }>
Icon URLs at various resolutions for the alliance
- Defined in src/clients/AllianceClient.ts:87

getAlliances

getAlliances(): Promise<number[]>
Retrieve a list of all active alliance IDs in EVE Online.

Returns Promise<number[]>
An array of all active alliance IDs
- Defined in src/clients/AllianceClient.ts:96

fetchAllAlliances

fetchAllAlliances(concurrency?: number): Promise<number[]>
Parameters
- Optionalconcurrency: number
Returns Promise<number[]>
- Defined in src/clients/AllianceClient.ts:100

fetchAllCorporations

fetchAllCorporations(
allianceId: number,
concurrency?: number,
): Promise<number[]>
Parameters
- allianceId: number
- Optionalconcurrency: number
Returns Promise<number[]>
- Defined in src/clients/AllianceClient.ts:104

streamAlliances

streamAlliances(): AsyncGenerator<PageResult<number>, void, undefined>
Returns AsyncGenerator<PageResult<number>, void, undefined>
- Defined in src/clients/AllianceClient.ts:115

streamCorporations

streamCorporations(
allianceId: number,
): AsyncGenerator<PageResult<number>, void, undefined>
Parameters
- allianceId: number
Returns AsyncGenerator<PageResult<number>, void, undefined>
- Defined in src/clients/AllianceClient.ts:119

streamEndpoint

streamEndpoint<R>(
    endpointName:
        | "getAllianceById"
        | "getCorporations"
        | "getIcons"
        | "getAlliances",
    ...args: unknown[],
): AsyncGenerator<PageResult<R>, void, undefined>
Type Parameters
- R
Parameters
- endpointName: "getAllianceById" | "getCorporations" | "getIcons" | "getAlliances"
- ...args: unknown[]
Returns AsyncGenerator<PageResult<R>, void, undefined>
Inherited from BaseEsiClient.streamEndpoint
- Defined in src/clients/BaseEsiClient.ts:45

fetchAllEndpoint

fetchAllEndpoint<R>(
    endpointName:
        | "getAllianceById"
        | "getCorporations"
        | "getIcons"
        | "getAlliances",
    args: unknown[],
    concurrency?: number,
): Promise<R[]>
Type Parameters
- R
Parameters
- endpointName: "getAllianceById" | "getCorporations" | "getIcons" | "getAlliances"
- args: unknown[]
- Optionalconcurrency: number
Returns Promise<R[]>
Inherited from BaseEsiClient.fetchAllEndpoint
- Defined in src/clients/BaseEsiClient.ts:71

withMetadata

withMetadata(): WithMetadata<Omit<this, "withMetadata" | "withSafeMode">>
Returns WithMetadata<Omit<this, "withMetadata" | "withSafeMode">>
Inherited from BaseEsiClient.withMetadata
- Defined in src/clients/BaseEsiClient.ts:99

withSafeMode

withSafeMode(): WithSafeMode<Omit<this, "withMetadata" | "withSafeMode">>
Returns WithSafeMode<Omit<this, "withMetadata" | "withSafeMode">>
Inherited from BaseEsiClient.withSafeMode
- Defined in src/clients/BaseEsiClient.ts:110

Class AllianceClient

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns AllianceClient

Properties

Protectedapi

Protected_client

Protected_endpoints

Methods

getAllianceById

Parameters

Returns Promise< { alliance_id?: number; name: string; ticker: string; creator_id: number; creator_corporation_id: number; executor_corporation_id?: number; date_founded: string; faction_id?: number; [key: string]: unknown; },>

getContacts

Parameters

Returns Promise< { contact_id: number; contact_type: string & {} | "character" | "corporation" | "alliance"; standing: number; label_ids?: number[]; [key: string]: unknown; }[],>

Deprecated

Requires

getContactLabels

Parameters

Returns Promise<{ label_id: number; label_name: string; [key: string]: unknown }[]>

Deprecated

Requires

getCorporations

Parameters

Returns Promise<number[]>

getIcons

Parameters

Returns Promise<{ px64x64?: string; px128x128?: string; [key: string]: unknown }>

getAlliances

Returns Promise<number[]>

fetchAllAlliances

Parameters

Returns Promise<number[]>

fetchAllCorporations

Parameters

Returns Promise<number[]>

streamAlliances

Returns AsyncGenerator<PageResult<number>, void, undefined>

streamCorporations

Parameters

Returns AsyncGenerator<PageResult<number>, void, undefined>

streamEndpoint

Type Parameters

Parameters

Returns AsyncGenerator<PageResult<R>, void, undefined>

fetchAllEndpoint

Type Parameters

Parameters

Returns Promise<R[]>

withMetadata

Returns WithMetadata<Omit<this, "withMetadata" | "withSafeMode">>

withSafeMode

Returns WithSafeMode<Omit<this, "withMetadata" | "withSafeMode">>

Settings

On This Page

`Protected`api

`Protected`_client

`Protected`_endpoints

Returns Promise<
{
alliance_id?: number;
name: string;
ticker: string;
creator_id: number;
creator_corporation_id: number;
executor_corporation_id?: number;
date_founded: string;
faction_id?: number;
[key: string]: unknown;
},
>

Returns Promise<
{
contact_id: number;
contact_type: string & {}
| "character"
| "corporation"
| "alliance";
standing: number;
label_ids?: number[];
[key: string]: unknown;
}[],
>