wretch
    Preparing search index...

    Type Alias ThrottlingCacheMiddleware

    ThrottlingCacheMiddleware: (
        options?: ThrottlingCacheOptions,
    ) => ConfiguredMiddleware & {
        cache: Map<any, any>;
        inflight: Map<any, any>;
        throttling: Set<unknown>;
        cacheResponse(key: any, response: any): void;
    }

    Options

    • throttle milliseconds

    the response will be stored for this amount of time before being deleted from the cache.

    • skip (url, opts) => boolean

    If skip returns true, then the request is performed even if present in the cache.

    • key (url, opts) => string

    Returns a key that is used to identify the request.

    • clear (url, opts) => boolean

    Clears the cache if true.

    • invalidate (url, opts) => string | RegExp | null

    Removes url(s) matching the string/RegExp from the cache.

    • condition response => boolean

    If false then the response will not be added to the cache.

    • flagResponseOnCacheHit string

    If set, a Response returned from the cache whill be flagged with a property name equal to this option.

    Type Declaration

      • (
            options?: ThrottlingCacheOptions,
        ): ConfiguredMiddleware & {
            cache: Map<any, any>;
            inflight: Map<any, any>;
            throttling: Set<unknown>;
            cacheResponse(key: any, response: any): void;
        }

      • Parameters

        Returns ConfiguredMiddleware & {
            cache: Map<any, any>;
            inflight: Map<any, any>;
            throttling: Set<unknown>;
            cacheResponse(key: any, response: any): void;
        }

    Settings

    Member Visibility

    On This Page

    Throttling cache middleware