Type alias ThrottlingCacheMiddleware

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

Type declaration

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

      A throttling cache which stores and serves server responses for a certain amount of time.

      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.

      Parameters

      Returns ConfiguredMiddleware & { cache: Map<any, any>; inflight: Map<any, any>; throttling: Set<unknown>; cacheResponse: any }

Generated using TypeDoc