@ampproject/toolbox-cache-list

AMP-Toolbox Cache List

Lists known AMP Caches, as available at https://cdn.ampproject.org/caches.json.

By default, it uses a one-behind caching strategy to fetch the caches. This can be customised by passing a custom fetch strategy to the constructor.

Usage

Install via:

$ npm install @ampproject/toolbox-cache-list@beta

List all known caches:

  const Caches = require('@ampproject/toolbox-cache-list');

  const allCaches = await Caches.list();

Which will return:

[
  {
    "id": "google",
    "name": "Google AMP Cache",
    "docs": "https://developers.google.com/amp/cache/",
    "cacheDomain": "cdn.ampproject.org",
    "updateCacheApiDomainSuffix": "cdn.ampproject.org",
    "thirdPartyFrameDomainSuffix": "ampproject.net"
  },
  {
    "id": "cloudflare",
    "name": "Cloudflare AMP Cache",
    "docs": "https://amp.cloudflare.com/",
    "cacheDomain": "amp.cloudflare.com",
    "updateCacheApiDomainSuffix": "amp.cloudflare.com",
    "thirdPartyFrameDomainSuffix": "cloudflareamp.net"
  },
  {
    "id": "bing",
    "name": "Bing AMP Cache",
    "docs": "https://www.bing.com/webmaster/help/bing-amp-cache-bc1c884c",
    "cacheDomain": "bing-amp.com",
    "updateCacheApiDomainSuffix": "bing-amp.com",
    "thirdPartyFrameDomainSuffix": "bing-amp.net"
  }
] 

Fetching info about a specific AMP cache via the cache id:

  const Caches = require('@ampproject/toolbox-cache-list');

  const googleAmpCache = await Caches.get('google');

Which will return:

{
  "id": "google",
  "name": "Google AMP Cache",
  "docs": "https://developers.google.com/amp/cache/",
  "cacheDomain": "cdn.ampproject.org",
  "updateCacheApiDomainSuffix": "cdn.ampproject.org",
  "thirdPartyFrameDomainSuffix": "ampproject.net"
}