Contentful Personalization & Analytics
    Preparing search index...

    Interface ProtectedFetchMethodOptions

    Options for createProtectedFetchMethod, combining timeout and retry behavior.

    interface ProtectedFetchMethodOptions {
        apiName?: string;
        fetchMethod?: FetchMethod;
        intervalTimeout?: number;
        onFailedAttempt?: (options: FetchMethodCallbackOptions) => void;
        onRequestTimeout?: (options: FetchMethodCallbackOptions) => void;
        requestTimeout?: number;
        retries?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    apiName? fetchMethod? intervalTimeout? onFailedAttempt? onRequestTimeout? requestTimeout? retries?

    Properties

    apiName?: string

    Human-readable name of the API being called.

    Used primarily for logging and error messages.

    fetchMethod?: FetchMethod

    Custom fetch implementation to use instead of the global fetch.

    This is useful for providing polyfills, mocks, or instrumented fetch implementations.

    intervalTimeout?: number

    Delay (in milliseconds) between retry attempts.

    0

    onFailedAttempt?: (options: FetchMethodCallbackOptions) => void

    Callback invoked whenever a retry attempt fails.

    Type Declaration

    This callback is invoked with additional metadata such as the attempt number and the number of retries left.

    onRequestTimeout?: (options: FetchMethodCallbackOptions) => void

    Callback invoked when a request exceeds the configured timeout.

    Type Declaration

    If this callback is not provided, a default error is logged.

    FetchMethodCallbackOptions

    requestTimeout?: number

    Maximum time (in milliseconds) to wait for a response before aborting the request.

    3000

    retries?: number

    Maximum number of retry attempts.

    1

    Settings

    Member Visibility

    On This Page

    Properties