Class LocationClient

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 locationEndpoints>
- LocationClient

Index

Constructors

constructor

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

Properties

`Protected`api

api: ClientMethods<T>

`Protected`_client

_client: ApiClient

`Protected`_endpoints

_endpoints: {
    getCharacterLocation: {
        path: "characters/{characterId}/location";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["characterId"];
        responseSchema: ZodObject<
            {
                solar_system_id: ZodNumber;
                station_id: ZodOptional<ZodNumber>;
                structure_id: ZodOptional<ZodNumber>;
            },
            $loose,
        >;
    };
    getCharacterOnline: {
        path: "characters/{characterId}/online";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["characterId"];
        responseSchema: ZodObject<
            {
                online: ZodBoolean;
                last_login: ZodOptional<ZodString>;
                last_logout: ZodOptional<ZodString>;
                logins: ZodOptional<ZodNumber>;
            },
            $loose,
        >;
    };
    getCharacterShip: {
        path: "characters/{characterId}/ship";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["characterId"];
        responseSchema: ZodObject<
            {
                ship_item_id: ZodNumber;
                ship_name: ZodString;
                ship_type_id: ZodNumber;
            },
            $loose,
        >;
    };
}

Methods

streamEndpoint

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

fetchAllEndpoint

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

getCharacterLocation

getCharacterLocation(
    characterId: number,
): Promise<
    {
        solar_system_id: number;
        station_id?: number;
        structure_id?: number;
        [key: string]: unknown;
    },
>
Retrieves the current solar system, station, and structure location of a character.
Parameters
- characterId: number
  The ID of the character to locate
Returns Promise<
    {
        solar_system_id: number;
        station_id?: number;
        structure_id?: number;
        [key: string]: unknown;
    },
>
The character's current location including solar system and optional station or structure

Requires
Authentication
- Defined in src/clients/LocationClient.ts:22

getCharacterOnline

getCharacterOnline(
    characterId: number,
): Promise<
    {
        online: boolean;
        last_login?: string;
        last_logout?: string;
        logins?: number;
        [key: string]: unknown;
    },
>
Checks whether a character is currently online and retrieves login/logout timestamps.
Parameters
- characterId: number
  The ID of the character to check
Returns Promise<
    {
        online: boolean;
        last_login?: string;
        last_logout?: string;
        logins?: number;
        [key: string]: unknown;
    },
>
The character's online status and last login/logout times

Requires
Authentication
- Defined in src/clients/LocationClient.ts:33

getCharacterShip

getCharacterShip(
    characterId: number,
): Promise<
    {
        ship_item_id: number;
        ship_name: string;
        ship_type_id: number;
        [key: string]: unknown;
    },
>
Retrieves the type, name, and item ID of the ship a character is currently flying.
Parameters
- characterId: number
  The ID of the character whose ship to retrieve
Returns Promise<
    {
        ship_item_id: number;
        ship_name: string;
        ship_type_id: number;
        [key: string]: unknown;
    },
>
The character's current ship details including type ID and ship name

Requires
Authentication
- Defined in src/clients/LocationClient.ts:44

Class LocationClient

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns LocationClient

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

getCharacterLocation

Parameters

Returns Promise< { solar_system_id: number; station_id?: number; structure_id?: number; [key: string]: unknown; },>

Requires

getCharacterOnline

Parameters

Returns Promise< { online: boolean; last_login?: string; last_logout?: string; logins?: number; [key: string]: unknown; },>

Requires

getCharacterShip

Parameters

Returns Promise< { ship_item_id: number; ship_name: string; ship_type_id: number; [key: string]: unknown; },>

Requires

Settings

On This Page

`Protected`api

`Protected`_client

`Protected`_endpoints

Returns Promise<
{
solar_system_id: number;
station_id?: number;
structure_id?: number;
[key: string]: unknown;
},
>

Returns Promise<
{
online: boolean;
last_login?: string;
last_logout?: string;
logins?: number;
[key: string]: unknown;
},
>

Returns Promise<
{
ship_item_id: number;
ship_name: string;
ship_type_id: number;
[key: string]: unknown;
},
>