@lgriffin/esi.ts - EVE Online ESI API Client - v12.3.0
    Preparing search index...

    Class DogmaClient

    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)

    Index
    constructor
    api _client _endpoints
    streamEndpoint fetchAllEndpoint withMetadata withSafeMode getAttributes getAttributeById getDynamicItemInfo getEffects getEffectById
    api: ClientMethods<T>

    Protected_client

    _client: ApiClient

    Protected_endpoints

    _endpoints: {
        getAttributes: {
            path: "dogma/attributes";
            method: "GET";
            requiresAuth: false;
            responseSchema: ZodArray<ZodNumber>;
        };
        getAttributeById: {
            path: "dogma/attributes/{attributeId}";
            method: "GET";
            requiresAuth: false;
            pathParams: readonly ["attributeId"];
            responseSchema: ZodObject<
                {
                    attribute_id: ZodNumber;
                    name: ZodOptional<ZodString>;
                    description: ZodOptional<ZodString>;
                    icon_id: ZodOptional<ZodNumber>;
                    default_value: ZodOptional<ZodNumber>;
                    published: ZodOptional<ZodBoolean>;
                    display_name: ZodOptional<ZodString>;
                    unit_id: ZodOptional<ZodNumber>;
                    stackable: ZodOptional<ZodBoolean>;
                    high_is_good: ZodOptional<ZodBoolean>;
                },
                $loose,
            >;
        };
        getEffects: {
            path: "dogma/effects";
            method: "GET";
            requiresAuth: false;
            responseSchema: ZodArray<ZodNumber>;
        };
        getEffectById: {
            path: "dogma/effects/{effectId}";
            method: "GET";
            requiresAuth: false;
            pathParams: readonly ["effectId"];
            responseSchema: ZodObject<
                {
                    effect_id: ZodNumber;
                    name: ZodOptional<ZodString>;
                    description: ZodOptional<ZodString>;
                    icon_id: ZodOptional<ZodNumber>;
                    display_name: ZodOptional<ZodString>;
                    published: ZodOptional<ZodBoolean>;
                    effect_category: ZodOptional<ZodNumber>;
                    is_assistance: ZodOptional<ZodBoolean>;
                    is_offensive: ZodOptional<ZodBoolean>;
                    is_warp_safe: ZodOptional<ZodBoolean>;
                    disallow_auto_repeat: ZodOptional<ZodBoolean>;
                    discharge_attribute_id: ZodOptional<ZodNumber>;
                    duration_attribute_id: ZodOptional<ZodNumber>;
                    electronic_chance: ZodOptional<ZodBoolean>;
                    falloff_attribute_id: ZodOptional<ZodNumber>;
                    modifiers: ZodOptional<
                        ZodArray<
                            ZodObject<
                                {
                                    domain: ZodOptional<ZodString>;
                                    effect_id: ZodOptional<ZodNumber>;
                                    func: ZodString;
                                    modified_attribute_id: ZodOptional<ZodNumber>;
                                    modifying_attribute_id: ZodOptional<ZodNumber>;
                                    operator: ZodOptional<ZodNumber>;
                                },
                                $loose,
                            >,
                        >,
                    >;
                    post_expression: ZodOptional<ZodNumber>;
                    pre_expression: ZodOptional<ZodNumber>;
                    range_attribute_id: ZodOptional<ZodNumber>;
                    range_chance: ZodOptional<ZodBoolean>;
                    tracking_speed_attribute_id: ZodOptional<ZodNumber>;
                },
                $loose,
            >;
        };
        getDynamicItemInfo: {
            path: "dogma/dynamic/items/{typeId}/{itemId}";
            method: "GET";
            requiresAuth: false;
            pathParams: readonly ["typeId", "itemId"];
            responseSchema: ZodObject<
                {
                    created_by: ZodNumber;
                    dogma_attributes: ZodArray<
                        ZodObject<{ attribute_id: ZodNumber; value: ZodNumber }, $loose>,
                    >;
                    dogma_effects: ZodArray<
                        ZodObject<{ effect_id: ZodNumber; is_default: ZodBoolean }, $loose>,
                    >;
                    mutator_type_id: ZodNumber;
                    source_type_id: ZodNumber;
                },
                $loose,
            >;
        };
    }

    • Type Parameters

      • R

      Parameters

      • endpointName:
            | "getAttributes"
            | "getAttributeById"
            | "getEffects"
            | "getEffectById"
            | "getDynamicItemInfo"
      • ...args: unknown[]

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

    • Type Parameters

      • R

      Parameters

      • endpointName:
            | "getAttributes"
            | "getAttributeById"
            | "getEffects"
            | "getEffectById"
            | "getDynamicItemInfo"
      • args: unknown[]
      • Optionalconcurrency: number

      Returns Promise<R[]>

    • Retrieves a list of all dogma attribute IDs.

      Returns Promise<number[]>

      An array of dogma attribute IDs

    • Retrieves detailed information about a specific dogma attribute.

      Parameters

      • attributeId: number

        The ID of the dogma attribute to look up

      Returns Promise<
          {
              attribute_id: number;
              name?: string;
              description?: string;
              icon_id?: number;
              default_value?: number;
              published?: boolean;
              display_name?: string;
              unit_id?: number;
              stackable?: boolean;
              high_is_good?: boolean;
              [key: string]: unknown;
          },
      >

      Detailed information about the dogma attribute

    • Retrieves the dynamic dogma information for a specific mutated item, including its modified attributes.

      Parameters

      • typeId: number

        The type ID of the item

      • itemId: number

        The item ID of the specific dynamic item

      Returns Promise<
          {
              created_by: number;
              dogma_attributes: {
                  attribute_id: number;
                  value: number;
                  [key: string]: unknown;
              }[];
              dogma_effects: {
                  effect_id: number;
                  is_default: boolean;
                  [key: string]: unknown;
              }[];
              mutator_type_id: number;
              source_type_id: number;
              [key: string]: unknown;
          },
      >

      Dynamic dogma information for the mutated item

    • Retrieves a list of all dogma effect IDs.

      Returns Promise<number[]>

      An array of dogma effect IDs

    • Retrieves detailed information about a specific dogma effect.

      Parameters

      • effectId: number

        The ID of the dogma effect to look up

      Returns Promise<
          {
              effect_id: number;
              name?: string;
              description?: string;
              icon_id?: number;
              display_name?: string;
              published?: boolean;
              effect_category?: number;
              is_assistance?: boolean;
              is_offensive?: boolean;
              is_warp_safe?: boolean;
              disallow_auto_repeat?: boolean;
              discharge_attribute_id?: number;
              duration_attribute_id?: number;
              electronic_chance?: boolean;
              falloff_attribute_id?: number;
              modifiers?: {
                  domain?: string;
                  effect_id?: number;
                  func: string;
                  modified_attribute_id?: number;
                  modifying_attribute_id?: number;
                  operator?: number;
                  [key: string]: unknown;
              }[];
              post_expression?: number;
              pre_expression?: number;
              range_attribute_id?: number;
              range_chance?: boolean;
              tracking_speed_attribute_id?: number;
              [key: string]: unknown;
          },
      >

      Detailed information about the dogma effect

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods