Class FittingsClient

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 fittingEndpoints>
- FittingsClient

Index

Constructors

constructor

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

Properties

`Protected`api

api: ClientMethods<T>

`Protected`_client

_client: ApiClient

`Protected`_endpoints

_endpoints: {
    getFittings: {
        path: "characters/{characterId}/fittings";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["characterId"];
        responseSchema: ZodArray<
            ZodObject<
                {
                    fitting_id: ZodNumber;
                    name: ZodString;
                    description: ZodString;
                    ship_type_id: ZodNumber;
                    items: ZodArray<
                        ZodObject<
                            {
                                type_id: ZodNumber;
                                flag: ZodUnion<readonly [ZodNumber, ZodString]>;
                                quantity: ZodNumber;
                            },
                            $loose,
                        >,
                    >;
                },
                $loose,
            >,
        >;
    };
    createFitting: {
        path: "characters/{characterId}/fittings";
        method: "POST";
        responseSchema: ZodObject<{ fitting_id: ZodNumber }, $loose>;
        requiresAuth: true;
        pathParams: readonly ["characterId"];
        hasBody: true;
    };
    deleteFitting: {
        path: "characters/{characterId}/fittings/{fittingId}";
        method: "DELETE";
        requiresAuth: true;
        pathParams: readonly ["characterId", "fittingId"];
    };
}

Methods

streamEndpoint

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

fetchAllEndpoint

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

getFittings

getFittings(
    characterId: number,
): Promise<
    {
        fitting_id: number;
        name: string;
        description: string;
        ship_type_id: number;
        items: {
            type_id: number;
            flag: string
            | number;
            quantity: number;
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    }[],
>
Retrieves all saved ship fittings for a character.
Parameters
- characterId: number
  The ID of the character
Returns Promise<
    {
        fitting_id: number;
        name: string;
        description: string;
        ship_type_id: number;
        items: {
            type_id: number;
            flag: string
            | number;
            quantity: number;
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    }[],
>
An array of the character's saved fittings

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

createFitting

createFitting(
characterId: number,
fittingData: object,
): Promise<{ fitting_id: number }>
Creates a new saved ship fitting for a character via POST.
Parameters
- characterId: number
  The ID of the character
- fittingData: object
  The fitting details including ship type and module layout
Returns Promise<{ fitting_id: number }>
The ID of the newly created fitting

Requires
Authentication
- Defined in src/clients/FittingsClient.ts:31

deleteFitting

deleteFitting(characterId: number, fittingId: number): Promise<void>
Deletes a saved ship fitting for a character.
Parameters
- characterId: number
  The ID of the character
- fittingId: number
  The ID of the fitting to delete
Returns Promise<void>

Requires
Authentication
- Defined in src/clients/FittingsClient.ts:45

fetchAllFittings

fetchAllFittings(
    characterId: number,
    concurrency?: number,
): Promise<
    {
        fitting_id: number;
        name: string;
        description: string;
        ship_type_id: number;
        items: {
            type_id: number;
            flag: string
            | number;
            quantity: number;
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    }[],
>
Parameters
- characterId: number
- Optionalconcurrency: number
Returns Promise<
    {
        fitting_id: number;
        name: string;
        description: string;
        ship_type_id: number;
        items: {
            type_id: number;
            flag: string
            | number;
            quantity: number;
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    }[],
>
- Defined in src/clients/FittingsClient.ts:49

streamFittings

streamFittings(
    characterId: number,
): AsyncGenerator<
    PageResult<
        {
            fitting_id: number;
            name: string;
            description: string;
            ship_type_id: number;
            items: {
                type_id: number;
                flag: string
                | number;
                quantity: number;
                [key: string]: unknown;
            }[];
            [key: string]: unknown;
        },
    >,
    void,
    undefined,
>
Parameters
- characterId: number
Returns AsyncGenerator<
    PageResult<
        {
            fitting_id: number;
            name: string;
            description: string;
            ship_type_id: number;
            items: {
                type_id: number;
                flag: string
                | number;
                quantity: number;
                [key: string]: unknown;
            }[];
            [key: string]: unknown;
        },
    >,
    void,
    undefined,
>
- Defined in src/clients/FittingsClient.ts:60

Class FittingsClient

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FittingsClient

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

getFittings

Parameters

Returns Promise< { fitting_id: number; name: string; description: string; ship_type_id: number; items: { type_id: number; flag: string | number; quantity: number; [key: string]: unknown; }[]; [key: string]: unknown; }[],>

Requires

createFitting

Parameters

Returns Promise<{ fitting_id: number }>

Requires

deleteFitting

Parameters

Returns Promise<void>

Requires

fetchAllFittings

Parameters

Returns Promise< { fitting_id: number; name: string; description: string; ship_type_id: number; items: { type_id: number; flag: string | number; quantity: number; [key: string]: unknown; }[]; [key: string]: unknown; }[],>

streamFittings

Parameters

Returns AsyncGenerator< PageResult< { fitting_id: number; name: string; description: string; ship_type_id: number; items: { type_id: number; flag: string | number; quantity: number; [key: string]: unknown; }[]; [key: string]: unknown; }, >, void, undefined,>

Settings

On This Page

`Protected`api

`Protected`_client

`Protected`_endpoints

Returns Promise<
{
fitting_id: number;
name: string;
description: string;
ship_type_id: number;
items: {
type_id: number;
flag: string
| number;
quantity: number;
[key: string]: unknown;
}[];
[key: string]: unknown;
}[],
>

Returns Promise<
{
fitting_id: number;
name: string;
description: string;
ship_type_id: number;
items: {
type_id: number;
flag: string
| number;
quantity: number;
[key: string]: unknown;
}[];
[key: string]: unknown;
}[],
>

Returns AsyncGenerator<
PageResult<
{
fitting_id: number;
name: string;
description: string;
ship_type_id: number;
items: {
type_id: number;
flag: string
| number;
quantity: number;
[key: string]: unknown;
}[];
[key: string]: unknown;
},
>,
void,
undefined,
>