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

    Class RouteClient

    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 getRoute
    api: ClientMethods<T>

    Protected_client

    _client: ApiClient

    Protected_endpoints

    _endpoints: {
        getRoute: {
            path: "route/{origin}/{destination}";
            method: "POST";
            requiresAuth: false;
            pathParams: readonly ["origin", "destination"];
            hasBody: true;
            responseSchema: ZodObject<{ route: ZodArray<ZodNumber> }, $loose>;
        };
    }

    • Type Parameters

      • R

      Parameters

      • endpointName: "getRoute"
      • args: unknown[]
      • Optionalconcurrency: number

      Returns Promise<R[]>

    • Calculates a route between two solar systems, returning the list of system IDs along the path via POST.

      Parameters

      • origin: number

        The solar system ID to start the route from

      • destination: number

        The solar system ID to route to

      • Optionaloptions: RouteOptions

        Optional routing preferences such as route type, avoided systems, and custom connections

      Returns Promise<number[]>

      An ordered list of solar system IDs representing the route

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods