Class WarsClient

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 warEndpoints>
- WarsClient

Index

Constructors

constructor

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

Properties

`Protected`api

api: ClientMethods<T>

`Protected`_client

_client: ApiClient

`Protected`_endpoints

_endpoints: {
    getWars: {
        path: "wars";
        method: "GET";
        requiresAuth: false;
        responseSchema: ZodArray<ZodNumber>;
    };
    getWarById: {
        path: "wars/{warId}";
        method: "GET";
        requiresAuth: false;
        pathParams: readonly ["warId"];
        responseSchema: ZodObject<
            {
                id: ZodNumber;
                declared: ZodString;
                started: ZodOptional<ZodString>;
                finished: ZodOptional<ZodString>;
                retracted: ZodOptional<ZodString>;
                mutual: ZodBoolean;
                open_for_allies: ZodBoolean;
                aggressor: ZodObject<
                    {
                        corporation_id: ZodOptional<ZodNumber>;
                        alliance_id: ZodOptional<ZodNumber>;
                        isk_destroyed: ZodNumber;
                        ships_killed: ZodNumber;
                    },
                    $loose,
                >;
                defender: ZodObject<
                    {
                        corporation_id: ZodOptional<ZodNumber>;
                        alliance_id: ZodOptional<ZodNumber>;
                        isk_destroyed: ZodNumber;
                        ships_killed: ZodNumber;
                    },
                    $loose,
                >;
                allies: ZodOptional<
                    ZodArray<
                        ZodObject<
                            {
                                corporation_id: ZodOptional<ZodNumber>;
                                alliance_id: ZodOptional<ZodNumber>;
                            },
                            $loose,
                        >,
                    >,
                >;
            },
            $loose,
        >;
    };
    getWarKillmails: {
        path: "wars/{warId}/killmails";
        method: "GET";
        requiresAuth: false;
        pathParams: readonly ["warId"];
        responseSchema: ZodArray<
            ZodObject<
                { killmail_id: ZodNumber; killmail_hash: ZodString },
                $loose,
            >,
        >;
    };
}

Methods

streamEndpoint

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

fetchAllEndpoint

fetchAllEndpoint<R>(
    endpointName: "getWars" | "getWarById" | "getWarKillmails",
    args: unknown[],
    concurrency?: number,
): Promise<R[]>
Type Parameters
- R
Parameters
- endpointName: "getWars" | "getWarById" | "getWarKillmails"
- 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

getWars

getWars(): Promise<number[]>
Retrieves a list of all war IDs, ordered by war ID descending.

Returns Promise<number[]>
A list of war IDs
- Defined in src/clients/WarsClient.ts:17

getWarById

getWarById(
    warId: number,
): Promise<
    {
        id: number;
        declared: string;
        started?: string;
        finished?: string;
        retracted?: string;
        mutual: boolean;
        open_for_allies: boolean;
        aggressor: {
            corporation_id?: number;
            alliance_id?: number;
            isk_destroyed: number;
            ships_killed: number;
            [key: string]: unknown;
        };
        defender: {
            corporation_id?: number;
            alliance_id?: number;
            isk_destroyed: number;
            ships_killed: number;
            [key: string]: unknown;
        };
        allies?: {
            corporation_id?: number;
            alliance_id?: number;
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    },
>
Retrieves detailed information about a specific war, including aggressors, defenders, and status.
Parameters
- warId: number
  The ID of the war
Returns Promise<
    {
        id: number;
        declared: string;
        started?: string;
        finished?: string;
        retracted?: string;
        mutual: boolean;
        open_for_allies: boolean;
        aggressor: {
            corporation_id?: number;
            alliance_id?: number;
            isk_destroyed: number;
            ships_killed: number;
            [key: string]: unknown;
        };
        defender: {
            corporation_id?: number;
            alliance_id?: number;
            isk_destroyed: number;
            ships_killed: number;
            [key: string]: unknown;
        };
        allies?: {
            corporation_id?: number;
            alliance_id?: number;
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    },
>
Detailed war information
- Defined in src/clients/WarsClient.ts:27

getWarKillmails

getWarKillmails(
warId: number,
): Promise<
{ killmail_id: number; killmail_hash: string; [key: string]: unknown }[],
>
Retrieves the killmail summaries associated with a specific war.
Parameters
- warId: number
  The ID of the war
Returns Promise<
{ killmail_id: number; killmail_hash: string; [key: string]: unknown }[],
>
A list of killmail summaries for the war
- Defined in src/clients/WarsClient.ts:37

fetchAllWars

fetchAllWars(concurrency?: number): Promise<number[]>
Parameters
- Optionalconcurrency: number
Returns Promise<number[]>
- Defined in src/clients/WarsClient.ts:41

fetchAllWarKillmails

fetchAllWarKillmails(
    warId: number,
    concurrency?: number,
): Promise<
    { killmail_id: number; killmail_hash: string; [key: string]: unknown }[],
>
Parameters
- warId: number
- Optionalconcurrency: number
Returns Promise<
{ killmail_id: number; killmail_hash: string; [key: string]: unknown }[],
>
- Defined in src/clients/WarsClient.ts:45

streamWars

streamWars(): AsyncGenerator<PageResult<number>, void, undefined>
Returns AsyncGenerator<PageResult<number>, void, undefined>
- Defined in src/clients/WarsClient.ts:56

streamWarKillmails

streamWarKillmails(
    warId: number,
): AsyncGenerator<
    PageResult<
        { killmail_id: number; killmail_hash: string; [key: string]: unknown },
    >,
    void,
    undefined,
>
Parameters
- warId: number
Returns AsyncGenerator<
    PageResult<
        { killmail_id: number; killmail_hash: string; [key: string]: unknown },
    >,
    void,
    undefined,
>
- Defined in src/clients/WarsClient.ts:60

Class WarsClient

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns WarsClient

Properties

Protectedapi

Protected_client

Protected_endpoints

Methods

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">>

getWars

Returns Promise<number[]>

getWarById

Parameters

getWarKillmails

Parameters

Returns Promise< { killmail_id: number; killmail_hash: string; [key: string]: unknown }[],>

fetchAllWars

Parameters

Returns Promise<number[]>

fetchAllWarKillmails

Parameters

Returns Promise< { killmail_id: number; killmail_hash: string; [key: string]: unknown }[],>

streamWars

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

streamWarKillmails

Parameters

Returns AsyncGenerator< PageResult< { killmail_id: number; killmail_hash: string; [key: string]: unknown }, >, void, undefined,>

Settings

On This Page

`Protected`api

`Protected`_client

`Protected`_endpoints

Returns Promise<
{ killmail_id: number; killmail_hash: string; [key: string]: unknown }[],
>

Returns Promise<
{ killmail_id: number; killmail_hash: string; [key: string]: unknown }[],
>

Returns AsyncGenerator<
PageResult<
{ killmail_id: number; killmail_hash: string; [key: string]: unknown },
>,
void,
undefined,
>