Interface IHandler

interface IHandler {
    id: string;
    get inactive(): boolean;
    queueRequest(
        routeId: RouteData,
        url: string,
        options: RequestInit,
        requestData: HandlerRequestData,
    ): Promise<ResponseLike>;
}

Properties

id

Accessors

inactive

Methods

queueRequest

Properties

Readonlyid

id: string

The unique id of the handler

Accessors

inactive

  • get inactive(): boolean

    If the bucket is currently inactive (no pending requests)

    Returns boolean

Methods

queueRequest

  • queueRequest(
        routeId: RouteData,
        url: string,
        options: RequestInit,
        requestData: HandlerRequestData,
    ): Promise<ResponseLike>

    Queues a request to be sent

    Parameters

    • routeId: RouteData

      The generalized api route with literal ids for major parameters

    • url: string

      The url to do the request on

    • options: RequestInit

      All the information needed to make a request

    • requestData: HandlerRequestData

      Extra data from the user's request needed for errors and additional processing

    Returns Promise<ResponseLike>

Settings

Member Visibility

On This Page

Properties
Accessors
Methods