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

    Class MetaClient

    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 getOpenApiJson getOpenApiYaml getChangelog getCompatibilityDates getName getStatus
    api: ClientMethods<T>

    Protected_client

    _client: ApiClient

    Protected_endpoints

    _endpoints: {
        getOpenApiJson: {
            path: "meta/openapi.json";
            method: "GET";
            requiresAuth: false;
            responseSchema: ZodRecord<ZodString, ZodUnknown>;
        };
        getOpenApiYaml: {
            path: "meta/openapi.yaml";
            method: "GET";
            requiresAuth: false;
            responseSchema: ZodString;
            textResponse: { accept: "application/yaml, text/yaml, text/plain" };
        };
        getChangelog: {
            path: "meta/changelog";
            method: "GET";
            requiresAuth: false;
            responseSchema: ZodObject<
                {
                    changelog: ZodRecord<
                        ZodString,
                        ZodArray<
                            ZodObject<
                                {
                                    method: ZodString;
                                    path: ZodString;
                                    compatibility_date: ZodString;
                                    type: ZodType<
                                        (...) & (...)
                                        | "breaking"
                                        | "changed"
                                        | "new"
                                        | "removed",
                                        unknown,
                                        $ZodTypeInternals<(...) | (...) | (...) | (...) | (...), unknown>,
                                    >;
                                    description: ZodString;
                                },
                                $loose,
                            >,
                        >,
                    >;
                },
                $loose,
            >;
        };
        getCompatibilityDates: {
            path: "meta/compatibility-dates";
            method: "GET";
            requiresAuth: false;
            responseSchema: ZodObject<
                { compatibility_dates: ZodArray<ZodString> },
                $loose,
            >;
        };
        getName: {
            path: "meta/name";
            method: "GET";
            requiresAuth: false;
            responseSchema: ZodObject<
                {
                    current: ZodString;
                    history: ZodArray<
                        ZodObject<{ date: ZodString; name: ZodString }, $loose>,
                    >;
                },
                $loose,
            >;
        };
        getStatus: {
            path: "meta/status";
            method: "GET";
            requiresAuth: false;
            responseSchema: ZodObject<
                {
                    routes: ZodArray<
                        ZodObject<
                            {
                                method: ZodType<
                                    string & {}
                                    | "GET"
                                    | "POST"
                                    | "PUT"
                                    | "DELETE",
                                    unknown,
                                    $ZodTypeInternals<
                                        (...) & (...)
                                        | "GET"
                                        | "POST"
                                        | "PUT"
                                        | "DELETE",
                                        unknown,
                                    >,
                                >;
                                path: ZodString;
                                status: ZodType<
                                    | string & {}
                                    | "Unknown"
                                    | "OK"
                                    | "Degraded"
                                    | "Down"
                                    | "Recovering",
                                    unknown,
                                    $ZodTypeInternals<
                                        | (...) & (...)
                                        | "Unknown"
                                        | "OK"
                                        | "Degraded"
                                        | "Down"
                                        | "Recovering",
                                        unknown,
                                    >,
                                >;
                            },
                            $loose,
                        >,
                    >;
                },
                $loose,
            >;
        };
    }

    • Type Parameters

      • R

      Parameters

      • endpointName:
            | "getStatus"
            | "getOpenApiJson"
            | "getOpenApiYaml"
            | "getChangelog"
            | "getCompatibilityDates"
            | "getName"
      • ...args: unknown[]

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

    • Type Parameters

      • R

      Parameters

      • endpointName:
            | "getStatus"
            | "getOpenApiJson"
            | "getOpenApiYaml"
            | "getChangelog"
            | "getCompatibilityDates"
            | "getName"
      • args: unknown[]
      • Optionalconcurrency: number

      Returns Promise<R[]>

    • Retrieves the ESI OpenAPI specification in JSON format.

      Returns Promise<Record<string, any>>

      The full ESI OpenAPI specification as a JSON object

    • Retrieves the ESI OpenAPI specification in YAML format.

      Returns Promise<string>

      The full ESI OpenAPI specification as a YAML string

    • Retrieves the ESI changelog data.

      Returns Promise<
          {
              changelog: Record<
                  string,
                  {
                      method: string;
                      path: string;
                      compatibility_date: string;
                      type: string & {}
                      | "breaking"
                      | "changed"
                      | "new"
                      | "removed";
                      description: string;
                      [key: string]: unknown;
                  }[],
              >;
              [key: string]: unknown;
          },
      >

      { changelog }: the change entries keyed by compatibility date

    • Retrieves the list of ESI compatibility dates.

      Returns Promise<{ compatibility_dates: string[]; [key: string]: unknown }>

      An object containing the list of compatibility dates

    • Retrieves the ESI name.

      Returns Promise<
          {
              current: string;
              history: { date: string; name: string; [key: string]: unknown }[];
              [key: string]: unknown;
          },
      >

      { current, history }: the name ESI has now and the dated names it had before

    • Retrieves the health of each ESI route.

      Returns Promise<
          {
              routes: {
                  method: string & {}
                  | "GET"
                  | "POST"
                  | "PUT"
                  | "DELETE";
                  path: string;
                  status:
                      | string & {}
                      | "Unknown"
                      | "OK"
                      | "Degraded"
                      | "Down"
                      | "Recovering";
                  [key: string]: unknown;
              }[];
              [key: string]: unknown;
          },
      >

      { routes }, one entry per route with its method, path and status ('OK', 'Degraded', 'Down', ...)

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods