tencent cloud

The Cache API is designed based on the standard Web API Cache. During the runtime of edge functions, a global caches object that provides a group of methods for cache-related operations is injected.

Note：

The cached content takes effect only on the current data node and is not automatically copied to other data nodes.

Constructor API

• Use caches.default to fetch the default cache instance.

// Fetch the default cache instance.
const cache = caches.default;

// This method provides the same effect as `caches.default`.
await caches.open('default');

• Use caches.open to create a cache instance with the specified namespace.

// Create a cache instance with the specified namespace.
const cache = await caches.open(namespace); 

Parameters

The following table describes the parameters of the caches.open(namespace) method.

Methods

match

cache.match(request: string | Request, options?: MatchOptions): Promise<Response | undefined>

The match() method fetches the Response cache associated with the request and returns a Promise object. If the cache exists, the object contains the Response object. If not, the object contains undefined.

Note：

The cache.match() method does not forward requests to the origin. If the cache expires, the method throws a 504 error.

Parameters

MatchOptions

put

cache.put(request: string | Request, response: Response): Promise<undefined>

The put() method tries to add a response to the cache by using the given request as the cache key. A Promise object is returned regardless of whether caching is successful.

Note：

The put() method returns a 413 error if the Cache-Control header of the object specified in the response parameter instructs not to cache.

Parameters

Parameter limits

The cache.put method throws an error in the following scenarios:

• The request parameter specifies a method other than the GET method.
• The status code of the response parameter is 206 Partial Content.
• The response parameter contains a Vary: * header.

delete

cache.delete(request: string | Request, options?: DeleteOptions): Promise<boolean>

The delete() method deletes the response associated with the request from the cache. If no network exception occurs, a Promise containing true is returned. Otherwise, a Promise containing false is returned.

Parameters

DeleteOptions

References

• MDN documentation: Cache
• Sample Functions: Caching POST Requests
• Sample Functions: Using the Cache API