Class CharacterSkillsClient

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 skillEndpoints>
- CharacterSkillsClient

Index

Constructors

constructor

new CharacterSkillsClient(client: ApiClient): CharacterSkillsClient
Parameters
- client: ApiClient
Returns CharacterSkillsClient
Overrides BaseEsiClient.constructor
- Defined in src/clients/SkillsClient.ts:14

Properties

`Protected`api

api: ClientMethods<T>

`Protected`_client

_client: ApiClient

`Protected`_endpoints

_endpoints: {
    getCharacterAttributes: {
        path: "characters/{characterId}/attributes";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["characterId"];
        responseSchema: ZodObject<
            {
                charisma: ZodNumber;
                intelligence: ZodNumber;
                memory: ZodNumber;
                perception: ZodNumber;
                willpower: ZodNumber;
                bonus_remaps: ZodOptional<ZodNumber>;
                last_remap_date: ZodOptional<ZodString>;
                accrued_remap_cooldown_date: ZodOptional<ZodString>;
            },
            $loose,
        >;
    };
    getCharacterSkillQueue: {
        path: "characters/{characterId}/skillqueue";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["characterId"];
        responseSchema: ZodArray<
            ZodObject<
                {
                    skill_id: ZodNumber;
                    finished_level: ZodNumber;
                    queue_position: ZodNumber;
                    level_end_sp: ZodOptional<ZodNumber>;
                    level_start_sp: ZodOptional<ZodNumber>;
                    training_start_sp: ZodOptional<ZodNumber>;
                    start_date: ZodOptional<ZodString>;
                    finish_date: ZodOptional<ZodString>;
                },
                $loose,
            >,
        >;
    };
    getCharacterSkills: {
        path: "characters/{characterId}/skills";
        method: "GET";
        requiresAuth: true;
        pathParams: readonly ["characterId"];
        responseSchema: ZodObject<
            {
                skills: ZodArray<
                    ZodObject<
                        {
                            skill_id: ZodNumber;
                            skillpoints_in_skill: ZodNumber;
                            trained_skill_level: ZodNumber;
                            active_skill_level: ZodNumber;
                        },
                        $loose,
                    >,
                >;
                total_sp: ZodNumber;
                unallocated_sp: ZodOptional<ZodNumber>;
            },
            $loose,
        >;
    };
}

Methods

streamEndpoint

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

fetchAllEndpoint

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

getCharacterAttributes

getCharacterAttributes(
    characterId: number,
): Promise<
    {
        charisma: number;
        intelligence: number;
        memory: number;
        perception: number;
        willpower: number;
        bonus_remaps?: number;
        last_remap_date?: string;
        accrued_remap_cooldown_date?: string;
        [key: string]: unknown;
    },
>
Retrieves a character's neural remap attribute values (intelligence, memory, charisma, perception, willpower).
Parameters
- characterId: number
  The ID of the character
Returns Promise<
    {
        charisma: number;
        intelligence: number;
        memory: number;
        perception: number;
        willpower: number;
        bonus_remaps?: number;
        last_remap_date?: string;
        accrued_remap_cooldown_date?: string;
        [key: string]: unknown;
    },
>
The character's current attribute values and bonus remap information

Requires
Authentication
- Defined in src/clients/SkillsClient.ts:25

getCharacterSkillQueue

getCharacterSkillQueue(
    characterId: number,
): Promise<
    {
        skill_id: number;
        finished_level: number;
        queue_position: number;
        level_end_sp?: number;
        level_start_sp?: number;
        training_start_sp?: number;
        start_date?: string;
        finish_date?: string;
        [key: string]: unknown;
    }[],
>
Retrieves the skill training queue for a character.
Parameters
- characterId: number
  The ID of the character
Returns Promise<
    {
        skill_id: number;
        finished_level: number;
        queue_position: number;
        level_end_sp?: number;
        level_start_sp?: number;
        training_start_sp?: number;
        start_date?: string;
        finish_date?: string;
        [key: string]: unknown;
    }[],
>
An ordered list of skills currently in the character's training queue

Requires
Authentication
- Defined in src/clients/SkillsClient.ts:36

getCharacterSkills

getCharacterSkills(
    characterId: number,
): Promise<
    {
        skills: {
            skill_id: number;
            skillpoints_in_skill: number;
            trained_skill_level: number;
            active_skill_level: number;
            [key: string]: unknown;
        }[];
        total_sp: number;
        unallocated_sp?: number;
    },
>
Retrieves all trained skills for a character, including total and unallocated skill points.
Parameters
- characterId: number
  The ID of the character
Returns Promise<
    {
        skills: {
            skill_id: number;
            skillpoints_in_skill: number;
            trained_skill_level: number;
            active_skill_level: number;
            [key: string]: unknown;
        }[];
        total_sp: number;
        unallocated_sp?: number;
    },
>
The character's trained skills, total SP, and optionally unallocated SP

Requires
Authentication
- Defined in src/clients/SkillsClient.ts:47

fetchAllCharacterSkillQueue

fetchAllCharacterSkillQueue(
    characterId: number,
    concurrency?: number,
): Promise<
    {
        skill_id: number;
        finished_level: number;
        queue_position: number;
        level_end_sp?: number;
        level_start_sp?: number;
        training_start_sp?: number;
        start_date?: string;
        finish_date?: string;
        [key: string]: unknown;
    }[],
>
Parameters
- characterId: number
- Optionalconcurrency: number
Returns Promise<
    {
        skill_id: number;
        finished_level: number;
        queue_position: number;
        level_end_sp?: number;
        level_start_sp?: number;
        training_start_sp?: number;
        start_date?: string;
        finish_date?: string;
        [key: string]: unknown;
    }[],
>
- Defined in src/clients/SkillsClient.ts:55

streamCharacterSkillQueue

streamCharacterSkillQueue(
    characterId: number,
): AsyncGenerator<
    PageResult<
        {
            skill_id: number;
            finished_level: number;
            queue_position: number;
            level_end_sp?: number;
            level_start_sp?: number;
            training_start_sp?: number;
            start_date?: string;
            finish_date?: string;
            [key: string]: unknown;
        },
    >,
    void,
    undefined,
>
Parameters
- characterId: number
Returns AsyncGenerator<
    PageResult<
        {
            skill_id: number;
            finished_level: number;
            queue_position: number;
            level_end_sp?: number;
            level_start_sp?: number;
            training_start_sp?: number;
            start_date?: string;
            finish_date?: string;
            [key: string]: unknown;
        },
    >,
    void,
    undefined,
>
- Defined in src/clients/SkillsClient.ts:66

Class CharacterSkillsClient

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CharacterSkillsClient

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

getCharacterAttributes

Parameters

Returns Promise< { charisma: number; intelligence: number; memory: number; perception: number; willpower: number; bonus_remaps?: number; last_remap_date?: string; accrued_remap_cooldown_date?: string; [key: string]: unknown; },>

Requires

getCharacterSkillQueue

Parameters

Returns Promise< { skill_id: number; finished_level: number; queue_position: number; level_end_sp?: number; level_start_sp?: number; training_start_sp?: number; start_date?: string; finish_date?: string; [key: string]: unknown; }[],>

Requires

getCharacterSkills

Parameters

Returns Promise< { skills: { skill_id: number; skillpoints_in_skill: number; trained_skill_level: number; active_skill_level: number; [key: string]: unknown; }[]; total_sp: number; unallocated_sp?: number; },>

Requires

fetchAllCharacterSkillQueue

Parameters

Returns Promise< { skill_id: number; finished_level: number; queue_position: number; level_end_sp?: number; level_start_sp?: number; training_start_sp?: number; start_date?: string; finish_date?: string; [key: string]: unknown; }[],>

streamCharacterSkillQueue

Parameters

Returns AsyncGenerator< PageResult< { skill_id: number; finished_level: number; queue_position: number; level_end_sp?: number; level_start_sp?: number; training_start_sp?: number; start_date?: string; finish_date?: string; [key: string]: unknown; }, >, void, undefined,>

Settings

On This Page

`Protected`api

`Protected`_client

`Protected`_endpoints

Returns Promise<
{
charisma: number;
intelligence: number;
memory: number;
perception: number;
willpower: number;
bonus_remaps?: number;
last_remap_date?: string;
accrued_remap_cooldown_date?: string;
[key: string]: unknown;
},
>

Returns Promise<
{
skill_id: number;
finished_level: number;
queue_position: number;
level_end_sp?: number;
level_start_sp?: number;
training_start_sp?: number;
start_date?: string;
finish_date?: string;
[key: string]: unknown;
}[],
>

Returns Promise<
{
skills: {
skill_id: number;
skillpoints_in_skill: number;
trained_skill_level: number;
active_skill_level: number;
[key: string]: unknown;
}[];
total_sp: number;
unallocated_sp?: number;
},
>

Returns Promise<
{
skill_id: number;
finished_level: number;
queue_position: number;
level_end_sp?: number;
level_start_sp?: number;
training_start_sp?: number;
start_date?: string;
finish_date?: string;
[key: string]: unknown;
}[],
>

Returns AsyncGenerator<
PageResult<
{
skill_id: number;
finished_level: number;
queue_position: number;
level_end_sp?: number;
level_start_sp?: number;
training_start_sp?: number;
start_date?: string;
finish_date?: string;
[key: string]: unknown;
},
>,
void,
undefined,
>