Type Alias GetRequestOptions

GetRequestOptions: {
    acceptType?: MimeType;
    aptosConfig: AptosConfig;
    contentType?: MimeType;
    originMethod: string;
    overrides?: ClientConfig;
    params?: Record<string,
        | string
        | AnyNumber
        | boolean
        | undefined>;
    path: string;
    type: AptosApiType;
}

Options for making a GET request, including configuration for the API client.

Type declaration

  • 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

Settings

Member Visibility