Logos DX
    Preparing search index...

    Interface EventMap<S, H, P>

    Event map for FetchEngine - maps event names to their data types.

    Event names have been simplified by removing the fetch- prefix. This provides cleaner API while maintaining full type safety.

    // Subscribe to events
    engine.on('before-request', (data) => console.log('Request starting:', data.url));
    engine.on('cache-hit', (data) => console.log('Cache hit:', data.key));
    engine.on('state-set', (data) => console.log('State changed:', data.current));
    interface EventMap<S = unknown, H = unknown, P = unknown> {
        abort: EventData<S, H, P>;
        "after-request": EventData<S, H, P>;
        "before-request": EventData<S, H, P>;
        "cache-hit": CacheEventData<S, H, P>;
        "cache-miss": CacheEventData<S, H, P>;
        "cache-revalidate": CacheEventData<S, H, P>;
        "cache-revalidate-error": CacheEventData<S, H, P>;
        "cache-set": CacheEventData<S, H, P>;
        "cache-stale": CacheEventData<S, H, P>;
        "config-change": OptionsEventData;
        "dedupe-join": DedupeEventData<S, H, P>;
        "dedupe-start": DedupeEventData<S, H, P>;
        error: EventData<S, H, P>;
        "header-add": PropertyEventData<DictAndT<H>>;
        "header-remove": PropertyEventData<DictAndT<H>>;
        "param-add": PropertyEventData<DictAndT<P>>;
        "param-remove": PropertyEventData<DictAndT<P>>;
        "ratelimit-abort": RateLimitEventData<S, H, P>;
        "ratelimit-acquire": RateLimitEventData<S, H, P>;
        "ratelimit-reject": RateLimitEventData<S, H, P>;
        "ratelimit-wait": RateLimitEventData<S, H, P>;
        response: EventData<S, H, P>;
        "response-4xx": EventData<S, H, P>;
        "response-5xx": EventData<S, H, P>;
        retry: RetryEventData<S, H, P>;
        "state-reset": StateEventData<S>;
        "state-set": StateEventData<S>;
        "url-change": { state: S; url: string };
    }

    Type Parameters

    • S = unknown

      Instance state type

    • H = unknown

      Instance headers type

    • P = unknown

      Instance params type

    Index

    Properties

    abort after-request before-request cache-hit cache-miss cache-revalidate cache-revalidate-error cache-set cache-stale config-change dedupe-join dedupe-start error header-add header-remove param-add param-remove ratelimit-abort ratelimit-acquire ratelimit-reject ratelimit-wait response response-4xx response-5xx retry state-reset state-set url-change

    Properties

    abort: EventData<S, H, P>
    "after-request": EventData<S, H, P>
    "before-request": EventData<S, H, P>
    "cache-hit": CacheEventData<S, H, P>
    "cache-miss": CacheEventData<S, H, P>
    "cache-revalidate": CacheEventData<S, H, P>
    "cache-revalidate-error": CacheEventData<S, H, P>
    "cache-set": CacheEventData<S, H, P>
    "cache-stale": CacheEventData<S, H, P>
    "config-change": OptionsEventData
    "dedupe-join": DedupeEventData<S, H, P>
    "dedupe-start": DedupeEventData<S, H, P>
    error: EventData<S, H, P>

    Transport failure or a parse failure on an ok: true body. Never non-2xx.

    "header-add": PropertyEventData<DictAndT<H>>
    "header-remove": PropertyEventData<DictAndT<H>>
    "param-add": PropertyEventData<DictAndT<P>>
    "param-remove": PropertyEventData<DictAndT<P>>
    "ratelimit-abort": RateLimitEventData<S, H, P>

    Terminal event for a wait that ended because the request aborted. Pairs with ratelimit-wait.

    "ratelimit-acquire": RateLimitEventData<S, H, P>
    "ratelimit-reject": RateLimitEventData<S, H, P>
    "ratelimit-wait": RateLimitEventData<S, H, P>
    response: EventData<S, H, P>

    Fires for every completed exchange, any status.

    "response-4xx": EventData<S, H, P>

    Fires alongside response when status is 400-499.

    "response-5xx": EventData<S, H, P>

    Fires alongside response when status is 500-599.

    retry: RetryEventData<S, H, P>
    "state-reset": StateEventData<S>
    "state-set": StateEventData<S>
    "url-change": { state: S; url: string }

    Settings

    Member Visibility

    On This Page

    Properties