Class KillmailsClient

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 killmailEndpoints>
- KillmailsClient

Index

Constructors

constructor

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

Properties

`Protected`api

api: ClientMethods<T>

`Protected`_client

_client: ApiClient

`Protected`_endpoints

_endpoints: {
    getCharacterRecentKillmails: {
        path: "characters/{characterId}/killmails/recent";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["characterId"];
        responseSchema: ZodArray<
            ZodObject<
                { killmail_id: ZodNumber; killmail_hash: ZodString },
                $loose,
            >,
        >;
    };
    getCorporationRecentKillmails: {
        path: "corporations/{corporationId}/killmails/recent";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["corporationId"];
        responseSchema: ZodArray<
            ZodObject<
                { killmail_id: ZodNumber; killmail_hash: ZodString },
                $loose,
            >,
        >;
    };
    getKillmail: {
        path: "killmails/{killmailId}/{killmailHash}";
        method: "GET";
        requiresAuth: false;
        pathParams: readonly ["killmailId", "killmailHash"];
        responseSchema: ZodObject<
            {
                killmail_id: ZodNumber;
                killmail_time: ZodString;
                solar_system_id: ZodNumber;
                moon_id: ZodOptional<ZodNumber>;
                war_id: ZodOptional<ZodNumber>;
                victim: ZodObject<
                    {
                        character_id: ZodOptional<ZodNumber>;
                        corporation_id: ZodOptional<ZodNumber>;
                        alliance_id: ZodOptional<ZodNumber>;
                        faction_id: ZodOptional<ZodNumber>;
                        ship_type_id: ZodNumber;
                        damage_taken: ZodNumber;
                        position: ZodOptional<
                            ZodObject<{ x: ZodNumber; y: ZodNumber; z: ZodNumber }, $loose>,
                        >;
                        items: ZodOptional<ZodArray<ZodUnknown>>;
                    },
                    $loose,
                >;
                attackers: ZodArray<
                    ZodObject<
                        {
                            character_id: ZodOptional<ZodNumber>;
                            corporation_id: ZodOptional<ZodNumber>;
                            alliance_id: ZodOptional<ZodNumber>;
                            faction_id: ZodOptional<ZodNumber>;
                            ship_type_id: ZodOptional<ZodNumber>;
                            weapon_type_id: ZodOptional<ZodNumber>;
                            damage_done: ZodNumber;
                            final_blow: ZodBoolean;
                            security_status: ZodNumber;
                        },
                        $loose,
                    >,
                >;
            },
            $loose,
        >;
    };
}

Methods

streamEndpoint

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

fetchAllEndpoint

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

getCharacterRecentKillmails

getCharacterRecentKillmails(
characterId: number,
): Promise<
{ killmail_id: number; killmail_hash: string; [key: string]: unknown }[],
>
Retrieves a list of recent killmail summaries for a character.
Parameters
- characterId: number
  The ID of the character to fetch killmails for
Returns Promise<
{ killmail_id: number; killmail_hash: string; [key: string]: unknown }[],
>
A list of recent killmail summaries including killmail IDs and hashes

Requires
Authentication
- Defined in src/clients/KillmailsClient.ts:19

getCorporationRecentKillmails

getCorporationRecentKillmails(
corporationId: number,
): Promise<
{ killmail_id: number; killmail_hash: string; [key: string]: unknown }[],
>
Retrieves a list of recent killmail summaries for a corporation.
Parameters
- corporationId: number
  The ID of the corporation to fetch killmails for
Returns Promise<
{ killmail_id: number; killmail_hash: string; [key: string]: unknown }[],
>
A list of recent killmail summaries including killmail IDs and hashes

Requires
Authentication
- Defined in src/clients/KillmailsClient.ts:30

getKillmail

getKillmail(
    killmailId: number,
    killmailHash: string,
): Promise<
    {
        killmail_id: number;
        killmail_time: string;
        solar_system_id: number;
        moon_id?: number;
        war_id?: number;
        victim: {
            character_id?: number;
            corporation_id?: number;
            alliance_id?: number;
            faction_id?: number;
            ship_type_id: number;
            damage_taken: number;
            position?: { x: number; y: number; z: number; [key: string]: unknown };
            items?: unknown[];
            [key: string]: unknown;
        };
        attackers: {
            character_id?: number;
            corporation_id?: number;
            alliance_id?: number;
            faction_id?: number;
            ship_type_id?: number;
            weapon_type_id?: number;
            damage_done: number;
            final_blow: boolean;
            security_status: number;
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    },
>
Retrieves the full details of a specific killmail by its ID and hash.
Parameters
- killmailId: number
  The ID of the killmail to retrieve
- killmailHash: string
  The hash of the killmail for verification
Returns Promise<
    {
        killmail_id: number;
        killmail_time: string;
        solar_system_id: number;
        moon_id?: number;
        war_id?: number;
        victim: {
            character_id?: number;
            corporation_id?: number;
            alliance_id?: number;
            faction_id?: number;
            ship_type_id: number;
            damage_taken: number;
            position?: { x: number; y: number; z: number; [key: string]: unknown };
            items?: unknown[];
            [key: string]: unknown;
        };
        attackers: {
            character_id?: number;
            corporation_id?: number;
            alliance_id?: number;
            faction_id?: number;
            ship_type_id?: number;
            weapon_type_id?: number;
            damage_done: number;
            final_blow: boolean;
            security_status: number;
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    },
>
The full killmail details including victim, attackers, and items
- Defined in src/clients/KillmailsClient.ts:43

fetchAllCharacterRecentKillmails

fetchAllCharacterRecentKillmails(
    characterId: number,
    concurrency?: number,
): Promise<
    { killmail_id: number; killmail_hash: string; [key: string]: unknown }[],
>
Parameters
- characterId: number
- Optionalconcurrency: number
Returns Promise<
{ killmail_id: number; killmail_hash: string; [key: string]: unknown }[],
>
- Defined in src/clients/KillmailsClient.ts:47

fetchAllCorporationRecentKillmails

fetchAllCorporationRecentKillmails(
    corporationId: number,
    concurrency?: number,
): Promise<
    { killmail_id: number; killmail_hash: string; [key: string]: unknown }[],
>
Parameters
- corporationId: number
- Optionalconcurrency: number
Returns Promise<
{ killmail_id: number; killmail_hash: string; [key: string]: unknown }[],
>
- Defined in src/clients/KillmailsClient.ts:58

streamCharacterRecentKillmails

streamCharacterRecentKillmails(
    characterId: number,
): AsyncGenerator<
    PageResult<
        { killmail_id: number; killmail_hash: string; [key: string]: unknown },
    >,
    void,
    undefined,
>
Parameters
- characterId: number
Returns AsyncGenerator<
    PageResult<
        { killmail_id: number; killmail_hash: string; [key: string]: unknown },
    >,
    void,
    undefined,
>
- Defined in src/clients/KillmailsClient.ts:69

streamCorporationRecentKillmails

streamCorporationRecentKillmails(
    corporationId: number,
): AsyncGenerator<
    PageResult<
        { killmail_id: number; killmail_hash: string; [key: string]: unknown },
    >,
    void,
    undefined,
>
Parameters
- corporationId: number
Returns AsyncGenerator<
    PageResult<
        { killmail_id: number; killmail_hash: string; [key: string]: unknown },
    >,
    void,
    undefined,
>
- Defined in src/clients/KillmailsClient.ts:78

Class KillmailsClient

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns KillmailsClient

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

getCharacterRecentKillmails

Parameters

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

Requires

getCorporationRecentKillmails

Parameters

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

Requires

getKillmail

Parameters

fetchAllCharacterRecentKillmails

Parameters

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

fetchAllCorporationRecentKillmails

Parameters

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

streamCharacterRecentKillmails

Parameters

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

streamCorporationRecentKillmails

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

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