Class ClonesClient

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 cloneEndpoints>
- ClonesClient

Index

Constructors

constructor

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

Properties

`Protected`api

api: ClientMethods<T>

`Protected`_client

_client: ApiClient

`Protected`_endpoints

_endpoints: {
    getClones: {
        path: "characters/{characterId}/clones";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["characterId"];
        responseSchema: ZodObject<
            {
                home_location: ZodOptional<
                    ZodObject<
                        {
                            location_id: ZodOptional<ZodNumber>;
                            location_type: ZodOptional<
                                ZodType<
                                    (...) & (...)
                                    | "station"
                                    | "structure",
                                    unknown,
                                    $ZodTypeInternals<(...) | (...) | (...), unknown>,
                                >,
                            >;
                        },
                        $loose,
                    >,
                >;
                jump_clones: ZodArray<
                    ZodObject<
                        {
                            jump_clone_id: ZodNumber;
                            location_id: ZodNumber;
                            location_type: ZodType<
                                string & {}
                                | "station"
                                | "structure",
                                unknown,
                                $ZodTypeInternals<(...) & (...) | "station" | "structure", unknown>,
                            >;
                            implants: ZodArray<ZodNumber>;
                            name: ZodOptional<ZodString>;
                        },
                        $loose,
                    >,
                >;
                last_clone_jump_date: ZodOptional<ZodString>;
                last_station_change_date: ZodOptional<ZodString>;
            },
            $loose,
        >;
    };
    getImplants: {
        path: "characters/{characterId}/implants";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["characterId"];
        responseSchema: ZodArray<ZodNumber>;
    };
}

Methods

streamEndpoint

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

fetchAllEndpoint

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

getClones

getClones(
    characterId: number,
): Promise<
    {
        home_location?: {
            location_id?: number;
            location_type?: string & {}
            | "station"
            | "structure";
            [key: string]: unknown;
        };
        jump_clones: {
            jump_clone_id: number;
            location_id: number;
            location_type: string & {}
            | "station"
            | "structure";
            implants: number[];
            name?: string;
            [key: string]: unknown;
        }[];
        last_clone_jump_date?: string;
        last_station_change_date?: string;
        [key: string]: unknown;
    },
>
Retrieve a character's clone state, including home station and available jump clones.
Parameters
- characterId: number
  The ID of the character whose clone information to retrieve
Returns Promise<
    {
        home_location?: {
            location_id?: number;
            location_type?: string & {}
            | "station"
            | "structure";
            [key: string]: unknown;
        };
        jump_clones: {
            jump_clone_id: number;
            location_id: number;
            location_type: string & {}
            | "station"
            | "structure";
            implants: number[];
            name?: string;
            [key: string]: unknown;
        }[];
        last_clone_jump_date?: string;
        last_station_change_date?: string;
        [key: string]: unknown;
    },
>
Clone information including home location and jump clone details

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

getImplants

getImplants(characterId: number): Promise<number[]>
Retrieve the implants currently installed in a character's active clone.
Parameters
- characterId: number
  The ID of the character whose implants to retrieve
Returns Promise<number[]>
An array of type IDs for the currently installed implants

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

fetchAllImplants

fetchAllImplants(characterId: number, concurrency?: number): Promise<number[]>
Parameters
- characterId: number
- Optionalconcurrency: number
Returns Promise<number[]>
- Defined in src/clients/ClonesClient.ts:34

streamImplants

streamImplants(
characterId: number,
): AsyncGenerator<PageResult<number>, void, undefined>
Parameters
- characterId: number
Returns AsyncGenerator<PageResult<number>, void, undefined>
- Defined in src/clients/ClonesClient.ts:45

Class ClonesClient

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ClonesClient

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

getClones

Parameters

Requires

getImplants

Parameters

Returns Promise<number[]>

Requires

fetchAllImplants

Parameters

Returns Promise<number[]>

streamImplants

Parameters

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

Settings

On This Page

`Protected`api

`Protected`_client

`Protected`_endpoints