Function getBinary

  • getBinary<Req extends {}>(
        options: GetRequestOptions,
    ): Promise<AptosResponse<Req, Buffer<ArrayBufferLike>>>
    Experimental

    Executes a GET request to retrieve data based on the provided options.

    Type Parameters

    • Req extends {}

    Parameters

    • options: GetRequestOptions

      The options for the GET request.

      • OptionalacceptType?: MimeType

        The accepted content type of the response of the API

      • aptosConfig: AptosConfig

        The config for the API client

      • OptionalcontentType?: MimeType

        The content type of the request body

      • originMethod: string

        The name of the API method

      • Optionaloverrides?: ClientConfig

        Specific client overrides for this request to override aptosConfig

      • Optionalparams?: Record<string, string | AnyNumber | boolean | undefined>

        The query parameters for the request

      • path: string

        The URL path to the API method

      • type: AptosApiType

        The type of API endpoint to call e.g. fullnode, indexer, etc

    Returns Promise<AptosResponse<Req, Buffer<ArrayBufferLike>>>

    The response from the GET request.

Settings

Member Visibility
MMNEPVFCICPMFPCPTTAAATR