Class SearchForApplicationBoxes

Base abstract class for JSON requests.

Data: The type returned from the do() method

Body: The structure of the response's body

Hierarchy

Constructors - GET

Properties

Methods - JSONRequest

Methods - Other

Methods - query

GET Constructors

Properties

intDecoding: IntDecoding
query: Record<string, any>

JSONRequest Methods

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

    Returns

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

    Parameters

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

      Additional headers to send in the request. Optional.

    Returns Promise<Uint8Array>

  • 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.

    Parameters

    • method: IntDecoding

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

    Returns SearchForApplicationBoxes

Other Methods

query Methods

  • Specify the next page of results.

    Example

    const maxResults = 20;
    const appID = 1234;

    const responsePage1 = await indexerClient
    .searchForApplicationBoxes(appID)
    .limit(maxResults)
    .do();
    const boxNamesPage1 = responsePage1.boxes.map(box => box.name);

    const responsePage2 = await indexerClient
    .searchForApplicationBoxes(appID)
    .limit(maxResults)
    .nextToken(responsePage1.nextToken)
    .do();
    const boxNamesPage2 = responsePage2.boxes.map(box => box.name);

    Parameters

    • next: string

    Returns SearchForApplicationBoxes

Generated using TypeDoc