Class Dryrun

Base abstract class for JSON requests.

Data: The type returned from the do() method

Body: The structure of the response's body




Methods - JSONRequest

Methods - Other



blob: Uint8Array
intDecoding: IntDecoding
query: Record<string, any>

JSONRequest Methods

  • Execute the request, but do not process the response data in any way.


    A promise which resolves to the raw response data, exactly as returned by the server.


    • headers: Record<string, any> = {}

      Additional headers to send in the request. Optional.

    Returns Promise<Uint8Array>

  • Prepare a JSON response before returning it.

    Use this method to change and restructure response data as needed after receiving it from the do() method.


    • body: Uint8Array | Record<string, any>

      Response body received

    Returns Record<string, any>

  • Configure how integers in this request's JSON response will be decoded.

    The options are:

    • "default": Integers will be decoded according to JSON.parse, meaning they will all be Numbers and any values greater than Number.MAX_SAFE_INTEGER will lose precision.
    • "safe": All integers will be decoded as Numbers, but if any values are greater than Number.MAX_SAFE_INTEGER an error will be thrown.
    • "mixed": Integers will be decoded as Numbers if they are less than or equal to Number.MAX_SAFE_INTEGER, otherwise they will be decoded as BigInts.
    • "bigint": All integers will be decoded as BigInts.


    • method: IntDecoding

      The method to use when parsing the response for this request. Must be one of "default", "safe", "mixed", or "bigint".

    Returns Dryrun

Other Methods

Generated using TypeDoc