Interface HttpResponse<TPathParams, TQueryParams, TRequestBody, TResponseBody>

HTTP response structure.

interface HttpResponse<TPathParams, TQueryParams, TRequestBody, TResponseBody> {
    attempts?: number;
    axiosConfig: AxiosRequestConfig<any>;
    data: TResponseBody;
    duration: number;
    headers: Headers;
    originalRequestProps: MakeHttpRequestProps<TPathParams, TQueryParams, TRequestBody, TResponseBody>;
    requestProps: RefinedRequestProps<TPathParams, TQueryParams, TRequestBody>;
    status: number;
    statusText: string;
    success: boolean;
    url: string;
}

Type Parameters

  • TPathParams = PathParams

    Type of the path parameters.

  • TQueryParams = QueryParams

    Type of the query parameters.

  • TRequestBody = any

    Type of the request body.

  • TResponseBody = any

    Type of the response body.

Properties

attempts? axiosConfig data duration headers originalRequestProps requestProps status statusText success url

Properties

Optionalattempts

attempts?: number

The number of retry attempts made. Optional.

axiosConfig

axiosConfig: AxiosRequestConfig<any>

The Axios configuration used for the request.

data

data: TResponseBody

The response body data.

duration

duration: number

The duration of the request in milliseconds.

headers

headers: Headers

The headers included in the response.

originalRequestProps

originalRequestProps: MakeHttpRequestProps<TPathParams, TQueryParams, TRequestBody, TResponseBody>

The original request properties before any refinement.

requestProps

requestProps: RefinedRequestProps<TPathParams, TQueryParams, TRequestBody>

The refined request properties, including resolved path and query parameters.

status

status: number

The HTTP status code of the response.

statusText

statusText: string

The status text corresponding to the HTTP status code.

success

success: boolean

Indicates whether the request was successful.

url

url: string

The URL of the request.

Settings

Member Visibility

On This Page

Properties