Interface RefinedRequestProps<TPathParams, TQueryParams, TRequestBody>

Interface representing the refined properties for making an HTTP request.

interface RefinedRequestProps<TPathParams, TQueryParams, TRequestBody> {
    headers: Headers;
    method: string;
    pathParams?: TPathParams;
    queryParams?: TQueryParams;
    requestBody?: TRequestBody;
    responseType: ResponseType;
    retryOptions: {
        backoffMultiplier: number;
        initialDelay: number;
        retries: number;
    };
    timeout: number;
    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.

Properties

headers method pathParams? queryParams? requestBody? responseType retryOptions timeout url

Properties

headers

headers: Headers

The headers to include in the request.

method

method: string

The HTTP method for the request.

OptionalpathParams

pathParams?: TPathParams

The path parameters for the request (optional).

OptionalqueryParams

queryParams?: TQueryParams

The query parameters for the request (optional).

OptionalrequestBody

requestBody?: TRequestBody

The request body for the request (optional).

responseType

responseType: ResponseType

The response type for the request.

retryOptions

retryOptions: {
    backoffMultiplier: number;
    initialDelay: number;
    retries: number;
}

The retry options for the request.

Type declaration

  • backoffMultiplier: number

    The multiplier to apply to the delay between subsequent retries. Must be between 1 and 2.

  • initialDelay: number

    The initial delay before the first retry attempt in milliseconds. Must be between 100 and 5000 ms.

  • retries: number

    The number of retry attempts. Must be between 0 and 5.

timeout

timeout: number

The timeout for the request in milliseconds.

url

url: string

The full URL for the request.

Settings

Member Visibility

On This Page

Properties