Interface UseHttpRequestHandlerProps

Interface representing the properties for setting up the HTTP request handler.

interface UseHttpRequestHandlerProps {
    baseUrl: string;
    headers?: Headers;
    logger?: Logger;
    responseType?: ResponseType;
    retryOptions?: {
        backoffMultiplier?: number;
        initialDelay?: number;
        retries?: number;
    };
    timeout?: number;
}

Properties

baseUrl headers? logger? responseType? retryOptions? timeout?

Properties

baseUrl

baseUrl: string

The base URL for the HTTP requests.

Optionalheaders

headers?: Headers

Optional headers to include in all requests.

Optionallogger

logger?: Logger

Optional logger function to log request details.

OptionalresponseType

responseType?: ResponseType

Optional response type for the requests (e.g., json, blob).

OptionalretryOptions

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

Optional retry options for the requests.

Type declaration

  • OptionalbackoffMultiplier?: number

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

  • OptionalinitialDelay?: number

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

  • Optionalretries?: number

    The number of retry attempts. Optional and must be between 0 and 5.

Optionaltimeout

timeout?: number

Optional timeout for the requests in milliseconds.

Settings

Member Visibility

On This Page

Properties