Class default

Allows you to split or normalize the cache space for a given route. Common use cases include:

  • serving multiple variants of the same URL based on a currency and/or language cookie.
  • caching different responses based on device type
  • ignoring all but a specific set of query parameters when looking up a response from the cache.

Example

 import { Router, CustomCacheKey } from '@edgio/core/router'

 new Router()
   .match('/some-path', ({ cache }) => {
     cache({
       key: new CustomCacheKey()
         .excludeAllQueryParametersExcept('color', 'size')
         .addCookie('currency')
         .addDevice()
       edge: {
         maxAgeSeconds: 60 * 60
       }
     })
   })

Hierarchy

  • default

Constructors

constructor

Methods

addBrowser addCookie addDevice addHeader addIsBot addVendor applyCaching excludeAllQueryParameters excludeAllQueryParametersExcept excludeQueryParameters removeBody removeMethod

Constructors

constructor

Methods

addBrowser

  • Specifies that requests should be cached on a per-browser basis. This will have no effect on service worker cache.

    Returns

    A self-reference, suitable for chaining.

    Returns default

addCookie

  • Adds a cookie to the cache key. This will have no effect on service worker cache.

    Returns

    A self-reference, suitable for chaining.

    Parameters

    • name: string

      The name of the cookie

    Returns default

addDevice

  • Specifies that requests should be cached on a per-device basis. This will have no effect on service worker cache.

    Returns

    A self-reference, suitable for chaining.

    Returns default

addHeader

  • Adds a request header to the cache key. This will have no effect on service worker cache.

    Returns

    A self-reference, suitable for chaining.

    Parameters

    • name: string

      The name of the request header

    Returns default

addIsBot

  • Specifies that requests should be cached differently for bots. This will have no effect on service worker cache.

    Returns

    A self-reference, suitable for chaining.

    Returns default

addVendor

  • Specifies that requests should be cached on a per-vendor basis. This will have no effect on service worker cache.

    Returns

    A self-reference, suitable for chaining.

    Returns default

applyCaching

  • Parameters

    Returns void

excludeAllQueryParameters

  • Excludes the entire query string from the cache key.

    Returns

    A self-reference, suitable for chaining.

    Returns default

excludeAllQueryParametersExcept

  • Excludes all query parameters except those provided from the cache key. We also refer to this as "whitelisting" query parameters. We recommend using this method over excludeQueryParameters as it's difficult to know all of the query parameters your application might receive and unexpected query parameters can lead to significantly lower cache hit rates.

    Returns

    A self-reference, suitable for chaining.

    Parameters

    • Rest ...names: string[]

      The names of the query parameters to whitelist

    Returns default

excludeQueryParameters

  • Excludes the provided query parameters from the cache key. All other parameters will still be part of the cache key. We also refer to this as "blacklisting" query parameters.

    Returns

    A self-reference, suitable for chaining.

    Parameters

    • Rest ...names: string[]

      The names of the query parameters to blacklist

    Returns default

removeBody

  • This method is not supported, and will throw an error if called.

    Returns void

removeMethod

  • Removes the HTTP method from the cache key.

    Returns

    A self-reference, suitable for chaining.

    Returns default

Settings

Member Visibility

Theme

Generated using TypeDoc