Class FleetClient

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 fleetEndpoints>
- FleetClient

Constructors

constructor

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

Properties

`Protected`api

api: ClientMethods<T>

`Protected`_client

_client: ApiClient

`Protected`_endpoints

_endpoints: {
    getCharacterFleetInfo: {
        path: "characters/{characterId}/fleet";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["characterId"];
        responseSchema: ZodObject<
            {
                fleet_id: ZodNumber;
                fleet_boss_id: ZodNumber;
                role: ZodType<
                    | string & {}
                    | "fleet_commander"
                    | "wing_commander"
                    | "squad_commander"
                    | "squad_member",
                    unknown,
                    $ZodTypeInternals<
                        | string & {}
                        | "fleet_commander"
                        | "wing_commander"
                        | "squad_commander"
                        | "squad_member",
                        unknown,
                    >,
                >;
                squad_id: ZodNumber;
                wing_id: ZodNumber;
            },
            $loose,
        >;
    };
    getFleetInfo: {
        path: "fleets/{fleetId}";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["fleetId"];
        responseSchema: ZodObject<
            {
                fleet_id: ZodOptional<ZodNumber>;
                fleet_boss_id: ZodOptional<ZodNumber>;
                is_free_move: ZodBoolean;
                is_registered: ZodBoolean;
                is_voice_enabled: ZodBoolean;
                motd: ZodString;
            },
            $loose,
        >;
    };
    updateFleet: {
        path: "fleets/{fleetId}";
        method: "PUT";
        requiresAuth: true;
        pathParams: readonly ["fleetId"];
        hasBody: true;
        requestSchema: ZodObject<
            {
                is_free_move: ZodOptional<ZodBoolean>;
                motd: ZodOptional<ZodString>;
            },
            $loose,
        >;
    };
    getFleetMembers: {
        path: "fleets/{fleetId}/members";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["fleetId"];
        responseSchema: ZodArray<
            ZodObject<
                {
                    character_id: ZodNumber;
                    ship_type_id: ZodNumber;
                    wing_id: ZodNumber;
                    squad_id: ZodNumber;
                    role: ZodType<
                        | string & {}
                        | "fleet_commander"
                        | "wing_commander"
                        | "squad_commander"
                        | "squad_member",
                        unknown,
                        $ZodTypeInternals<
                            | string & {}
                            | "fleet_commander"
                            | "wing_commander"
                            | "squad_commander"
                            | "squad_member",
                            unknown,
                        >,
                    >;
                    role_name: ZodString;
                    join_time: ZodString;
                    takes_fleet_warp: ZodBoolean;
                    solar_system_id: ZodNumber;
                    station_id: ZodOptional<ZodNumber>;
                },
                $loose,
            >,
        >;
    };
    createFleetInvitation: {
        path: "fleets/{fleetId}/members/";
        method: "POST";
        requiresAuth: true;
        pathParams: readonly ["fleetId"];
        hasBody: true;
    };
    kickFleetMember: {
        path: "fleets/{fleetId}/members/{memberId}/";
        method: "DELETE";
        requiresAuth: true;
        pathParams: readonly ["fleetId", "memberId"];
    };
    moveFleetMember: {
        path: "fleets/{fleetId}/members/{memberId}/";
        method: "PUT";
        requiresAuth: true;
        pathParams: readonly ["fleetId", "memberId"];
        hasBody: true;
    };
    deleteFleetSquad: {
        path: "fleets/{fleetId}/squads/{squadId}/";
        method: "DELETE";
        requiresAuth: true;
        pathParams: readonly ["fleetId", "squadId"];
    };
    renameFleetSquad: {
        path: "fleets/{fleetId}/squads/{squadId}/";
        method: "PUT";
        requiresAuth: true;
        pathParams: readonly ["fleetId", "squadId"];
        bodyBuilder: (name: string) => { name: string };
    };
    getFleetWings: {
        path: "fleets/{fleetId}/wings/";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["fleetId"];
        responseSchema: ZodArray<
            ZodObject<
                {
                    id: ZodNumber;
                    name: ZodString;
                    squads: ZodArray<ZodObject<{ id: ZodNumber; name: ZodString }, $loose>>;
                },
                $loose,
            >,
        >;
    };
    createFleetWing: {
        path: "fleets/{fleetId}/wings/";
        method: "POST";
        responseSchema: ZodObject<{ wing_id: ZodNumber }, $loose>;
        requiresAuth: true;
        pathParams: readonly ["fleetId"];
        hasBody: true;
    };
    deleteFleetWing: {
        path: "fleets/{fleetId}/wings/{wingId}/";
        method: "DELETE";
        requiresAuth: true;
        pathParams: readonly ["fleetId", "wingId"];
    };
    renameFleetWing: {
        path: "fleets/{fleetId}/wings/{wingId}/";
        method: "PUT";
        requiresAuth: true;
        pathParams: readonly ["fleetId", "wingId"];
        bodyBuilder: (name: string) => { name: string };
    };
    createFleetSquad: {
        path: "fleets/{fleetId}/wings/{wingId}/squads/";
        method: "POST";
        responseSchema: ZodObject<{ squad_id: ZodNumber }, $loose>;
        requiresAuth: true;
        pathParams: readonly ["fleetId", "wingId"];
    };
}

Methods

streamEndpoint

streamEndpoint<R>(
    endpointName:
        | "getCharacterFleetInfo"
        | "getFleetInfo"
        | "updateFleet"
        | "getFleetMembers"
        | "createFleetInvitation"
        | "kickFleetMember"
        | "moveFleetMember"
        | "deleteFleetSquad"
        | "renameFleetSquad"
        | "getFleetWings"
        | "createFleetWing"
        | "deleteFleetWing"
        | "renameFleetWing"
        | "createFleetSquad",
    ...args: unknown[],
): AsyncGenerator<PageResult<R>, void, undefined>
Type Parameters
- R
Parameters
- endpointName:
      | "getCharacterFleetInfo"
      | "getFleetInfo"
      | "updateFleet"
      | "getFleetMembers"
      | "createFleetInvitation"
      | "kickFleetMember"
      | "moveFleetMember"
      | "deleteFleetSquad"
      | "renameFleetSquad"
      | "getFleetWings"
      | "createFleetWing"
      | "deleteFleetWing"
      | "renameFleetWing"
      | "createFleetSquad"
- ...args: unknown[]
Returns AsyncGenerator<PageResult<R>, void, undefined>
Inherited from BaseEsiClient.streamEndpoint
- Defined in src/clients/BaseEsiClient.ts:45

fetchAllEndpoint

fetchAllEndpoint<R>(
    endpointName:
        | "getCharacterFleetInfo"
        | "getFleetInfo"
        | "updateFleet"
        | "getFleetMembers"
        | "createFleetInvitation"
        | "kickFleetMember"
        | "moveFleetMember"
        | "deleteFleetSquad"
        | "renameFleetSquad"
        | "getFleetWings"
        | "createFleetWing"
        | "deleteFleetWing"
        | "renameFleetWing"
        | "createFleetSquad",
    args: unknown[],
    concurrency?: number,
): Promise<R[]>
Type Parameters
- R
Parameters
- endpointName:
      | "getCharacterFleetInfo"
      | "getFleetInfo"
      | "updateFleet"
      | "getFleetMembers"
      | "createFleetInvitation"
      | "kickFleetMember"
      | "moveFleetMember"
      | "deleteFleetSquad"
      | "renameFleetSquad"
      | "getFleetWings"
      | "createFleetWing"
      | "deleteFleetWing"
      | "renameFleetWing"
      | "createFleetSquad"
- 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

getCharacterFleetInfo

getCharacterFleetInfo(
    characterId: number,
): Promise<
    {
        fleet_id: number;
        fleet_boss_id: number;
        role: | string & {}
        | "fleet_commander"
        | "wing_commander"
        | "squad_commander"
        | "squad_member";
        squad_id: number;
        wing_id: number;
        [key: string]: unknown;
    },
>
Retrieves the fleet that a character is currently in, including their role and wing/squad assignment.
Parameters
- characterId: number
  The ID of the character
Returns Promise<
    {
        fleet_id: number;
        fleet_boss_id: number;
        role: | string & {}
        | "fleet_commander"
        | "wing_commander"
        | "squad_commander"
        | "squad_member";
        squad_id: number;
        wing_id: number;
        [key: string]: unknown;
    },
>
Fleet membership information for the character

Requires
Authentication
- Defined in src/clients/FleetClient.ts:24

getFleetInformation

getFleetInformation(
    fleetId: number,
): Promise<
    {
        fleet_id?: number;
        fleet_boss_id?: number;
        is_free_move: boolean;
        is_registered: boolean;
        is_voice_enabled: boolean;
        motd: string;
        [key: string]: unknown;
    },
>
Retrieves detailed information about a fleet, including its MOTD and free-move setting.
Parameters
- fleetId: number
  The ID of the fleet
Returns Promise<
    {
        fleet_id?: number;
        fleet_boss_id?: number;
        is_free_move: boolean;
        is_registered: boolean;
        is_voice_enabled: boolean;
        motd: string;
        [key: string]: unknown;
    },
>
Detailed fleet information

Requires
Authentication
- Defined in src/clients/FleetClient.ts:35

updateFleet

updateFleet(fleetId: number, body: object): Promise<void>
Updates fleet settings such as the MOTD and free-move toggle via PUT.
Parameters
- fleetId: number
  The ID of the fleet
- body: object
  The fleet settings to update
Returns Promise<void>

Requires
Authentication
- Defined in src/clients/FleetClient.ts:46

getFleetMembers

getFleetMembers(
    fleetId: number,
): Promise<
    {
        character_id: number;
        ship_type_id: number;
        wing_id: number;
        squad_id: number;
        role: | string & {}
        | "fleet_commander"
        | "wing_commander"
        | "squad_commander"
        | "squad_member";
        role_name: string;
        join_time: string;
        takes_fleet_warp: boolean;
        solar_system_id: number;
        station_id?: number;
        [key: string]: unknown;
    }[],
>
Retrieves all current members of a fleet, including their ship types and roles.
Parameters
- fleetId: number
  The ID of the fleet
Returns Promise<
    {
        character_id: number;
        ship_type_id: number;
        wing_id: number;
        squad_id: number;
        role: | string & {}
        | "fleet_commander"
        | "wing_commander"
        | "squad_commander"
        | "squad_member";
        role_name: string;
        join_time: string;
        takes_fleet_warp: boolean;
        solar_system_id: number;
        station_id?: number;
        [key: string]: unknown;
    }[],
>
An array of fleet members

Requires
Authentication
- Defined in src/clients/FleetClient.ts:57

createFleetInvitation

createFleetInvitation(fleetId: number, body: object): Promise<void>
Sends an invitation to a character to join a fleet via POST.
Parameters
- fleetId: number
  The ID of the fleet
- body: object
  The invitation details including the character to invite and their role
Returns Promise<void>

Requires
Authentication
- Defined in src/clients/FleetClient.ts:68

kickFleetMember

kickFleetMember(fleetId: number, memberId: number): Promise<void>
Kicks a member from a fleet.
Parameters
- fleetId: number
  The ID of the fleet
- memberId: number
  The character ID of the member to kick
Returns Promise<void>

Requires
Authentication
- Defined in src/clients/FleetClient.ts:79

moveFleetMember

moveFleetMember(fleetId: number, memberId: number, body: object): Promise<void>
Moves a fleet member to a different wing, squad, or role via PUT.
Parameters
- fleetId: number
  The ID of the fleet
- memberId: number
  The character ID of the member to move
- body: object
  The target role, wing, and/or squad assignment
Returns Promise<void>

Requires
Authentication
- Defined in src/clients/FleetClient.ts:91

deleteFleetSquad

deleteFleetSquad(fleetId: number, squadId: number): Promise<void>
Deletes a squad from a fleet.
Parameters
- fleetId: number
  The ID of the fleet
- squadId: number
  The ID of the squad to delete
Returns Promise<void>

Requires
Authentication
- Defined in src/clients/FleetClient.ts:106

renameFleetSquad

renameFleetSquad(fleetId: number, squadId: number, name: string): Promise<void>
Renames a squad within a fleet via PUT.
Parameters
- fleetId: number
  The ID of the fleet
- squadId: number
  The ID of the squad to rename
- name: string
  The new name for the squad (max 10 characters)
Returns Promise<void>

Requires
Authentication
- Defined in src/clients/FleetClient.ts:118

getFleetWings

getFleetWings(
    fleetId: number,
): Promise<
    {
        id: number;
        name: string;
        squads: { id: number; name: string; [key: string]: unknown }[];
        [key: string]: unknown;
    }[],
>
Retrieves all wings and their squads for a fleet.
Parameters
- fleetId: number
  The ID of the fleet
Returns Promise<
    {
        id: number;
        name: string;
        squads: { id: number; name: string; [key: string]: unknown }[];
        [key: string]: unknown;
    }[],
>
An array of fleet wings with their nested squads

Requires
Authentication
- Defined in src/clients/FleetClient.ts:140

createFleetWing

createFleetWing(fleetId: number, body: object): Promise<{ wing_id: number }>
Creates a new wing in a fleet via POST.
Parameters
- fleetId: number
  The ID of the fleet
- body: object
  The wing creation details
Returns Promise<{ wing_id: number }>
The ID of the newly created wing

Requires
Authentication
- Defined in src/clients/FleetClient.ts:152

deleteFleetWing

deleteFleetWing(fleetId: number, wingId: number): Promise<void>
Deletes a wing from a fleet, along with all its squads.
Parameters
- fleetId: number
  The ID of the fleet
- wingId: number
  The ID of the wing to delete
Returns Promise<void>

Requires
Authentication
- Defined in src/clients/FleetClient.ts:163

renameFleetWing

renameFleetWing(fleetId: number, wingId: number, name: string): Promise<void>
Renames a wing within a fleet via PUT.
Parameters
- fleetId: number
  The ID of the fleet
- wingId: number
  The ID of the wing to rename
- name: string
  The new name for the wing (max 10 characters)
Returns Promise<void>

Requires
Authentication
- Defined in src/clients/FleetClient.ts:175

createFleetSquad

createFleetSquad(fleetId: number, wingId: number): Promise<{ squad_id: number }>
Creates a new squad under a wing in a fleet via POST.
Parameters
- fleetId: number
  The ID of the fleet
- wingId: number
  The ID of the wing to add the squad to
Returns Promise<{ squad_id: number }>
The ID of the newly created squad

Requires
Authentication
- Defined in src/clients/FleetClient.ts:198

fetchAllFleetMembers

fetchAllFleetMembers(
    fleetId: number,
    concurrency?: number,
): Promise<
    {
        character_id: number;
        ship_type_id: number;
        wing_id: number;
        squad_id: number;
        role: | string & {}
        | "fleet_commander"
        | "wing_commander"
        | "squad_commander"
        | "squad_member";
        role_name: string;
        join_time: string;
        takes_fleet_warp: boolean;
        solar_system_id: number;
        station_id?: number;
        [key: string]: unknown;
    }[],
>
Parameters
- fleetId: number
- Optionalconcurrency: number
Returns Promise<
    {
        character_id: number;
        ship_type_id: number;
        wing_id: number;
        squad_id: number;
        role: | string & {}
        | "fleet_commander"
        | "wing_commander"
        | "squad_commander"
        | "squad_member";
        role_name: string;
        join_time: string;
        takes_fleet_warp: boolean;
        solar_system_id: number;
        station_id?: number;
        [key: string]: unknown;
    }[],
>
- Defined in src/clients/FleetClient.ts:205

fetchAllFleetWings

fetchAllFleetWings(
    fleetId: number,
    concurrency?: number,
): Promise<
    {
        id: number;
        name: string;
        squads: { id: number; name: string; [key: string]: unknown }[];
        [key: string]: unknown;
    }[],
>
Parameters
- fleetId: number
- Optionalconcurrency: number
Returns Promise<
    {
        id: number;
        name: string;
        squads: { id: number; name: string; [key: string]: unknown }[];
        [key: string]: unknown;
    }[],
>
- Defined in src/clients/FleetClient.ts:216

streamFleetMembers

streamFleetMembers(
    fleetId: number,
): AsyncGenerator<
    PageResult<
        {
            character_id: number;
            ship_type_id: number;
            wing_id: number;
            squad_id: number;
            role: | string & {}
            | "fleet_commander"
            | "wing_commander"
            | "squad_commander"
            | "squad_member";
            role_name: string;
            join_time: string;
            takes_fleet_warp: boolean;
            solar_system_id: number;
            station_id?: number;
            [key: string]: unknown;
        },
    >,
    void,
    undefined,
>
Parameters
- fleetId: number
Returns AsyncGenerator<
    PageResult<
        {
            character_id: number;
            ship_type_id: number;
            wing_id: number;
            squad_id: number;
            role: | string & {}
            | "fleet_commander"
            | "wing_commander"
            | "squad_commander"
            | "squad_member";
            role_name: string;
            join_time: string;
            takes_fleet_warp: boolean;
            solar_system_id: number;
            station_id?: number;
            [key: string]: unknown;
        },
    >,
    void,
    undefined,
>
- Defined in src/clients/FleetClient.ts:227

streamFleetWings

streamFleetWings(
    fleetId: number,
): AsyncGenerator<
    PageResult<
        {
            id: number;
            name: string;
            squads: { id: number; name: string; [key: string]: unknown }[];
            [key: string]: unknown;
        },
    >,
    void,
    undefined,
>
Parameters
- fleetId: number
Returns AsyncGenerator<
    PageResult<
        {
            id: number;
            name: string;
            squads: { id: number; name: string; [key: string]: unknown }[];
            [key: string]: unknown;
        },
    >,
    void,
    undefined,
>
- Defined in src/clients/FleetClient.ts:233

Class FleetClient

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FleetClient

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

getCharacterFleetInfo

Parameters

Returns Promise< { fleet_id: number; fleet_boss_id: number; role: | string & {} | "fleet_commander" | "wing_commander" | "squad_commander" | "squad_member"; squad_id: number; wing_id: number; [key: string]: unknown; },>

Requires

getFleetInformation

Parameters

Returns Promise< { fleet_id?: number; fleet_boss_id?: number; is_free_move: boolean; is_registered: boolean; is_voice_enabled: boolean; motd: string; [key: string]: unknown; },>

Requires

updateFleet

Parameters

Returns Promise<void>

Requires

getFleetMembers

Parameters

Requires

createFleetInvitation

Parameters

Returns Promise<void>

Requires

kickFleetMember

Parameters

Returns Promise<void>

Requires

moveFleetMember

Parameters

Returns Promise<void>

Requires

deleteFleetSquad

Parameters

Returns Promise<void>

Requires

renameFleetSquad

Parameters

Returns Promise<void>

Requires

getFleetWings

Parameters

Returns Promise< { id: number; name: string; squads: { id: number; name: string; [key: string]: unknown }[]; [key: string]: unknown; }[],>

Requires

createFleetWing

Parameters

Returns Promise<{ wing_id: number }>

Requires

deleteFleetWing

Parameters

Returns Promise<void>

Requires

renameFleetWing

Parameters

Returns Promise<void>

Requires

createFleetSquad

Parameters

`Protected`api

`Protected`_client

`Protected`_endpoints

Returns Promise<
{
fleet_id: number;
fleet_boss_id: number;
role: | string & {}
| "fleet_commander"
| "wing_commander"
| "squad_commander"
| "squad_member";
squad_id: number;
wing_id: number;
[key: string]: unknown;
},
>

Returns Promise<
{
fleet_id?: number;
fleet_boss_id?: number;
is_free_move: boolean;
is_registered: boolean;
is_voice_enabled: boolean;
motd: string;
[key: string]: unknown;
},
>

Returns Promise<
{
id: number;
name: string;
squads: { id: number; name: string; [key: string]: unknown }[];
[key: string]: unknown;
}[],
>

Returns Promise<
{
id: number;
name: string;
squads: { id: number; name: string; [key: string]: unknown }[];
[key: string]: unknown;
}[],
>

Returns AsyncGenerator<
PageResult<
{
id: number;
name: string;
squads: { id: number; name: string; [key: string]: unknown }[];
[key: string]: unknown;
},
>,
void,
undefined,
>