Go Headless

Build Apps

Client

API Preview

Develop Websites

REST

Velo

GraphQL (Alpha)

An array of objects containing a `tag` field used to identify the cache to invalidate. All cached return values with any listed tags are invalidated. If no tags are specified, nothing is invalidated.

invalidationMethods

options

InvalidateCacheOptions

Clears the cache of the function return values using specified tags.

This function invalidates or clears the cached return values of your backend function calls, using specified tags. The `invalidationMethods` parameter takes an array of objects, each containing a `tag` field that represents the tags associated with the cached return values. These tags are defined using the `webMethod()` function in the [`wix-web-module`](https://dev.wix.com/docs/velo/api-reference/wix-web-module/web-method). For example, using an array such as `[{ tag: "contacts" }, { tag: "labels" }]` will invalidate any previously cached return values tagged with "contacts" or "labels".

<blockquote class="important">

__Important:__
- If you don't use the `tags` identifier property when caching the function call's return value, you can only invalidate the cached return value when the TTL expires, or when you republish your site with a code change.

- This function only invalidates the caches from your backend function calls. To invalidate the Server Side Rendering (SSR) cache for your site, use the `invalidateCache()` function from the [`wix-site-backend`](https://dev.wix.com/docs/velo/api-reference/wix-site-backend/invalidate-cache) module.

</blockquote>

import { cache } from "wix-cache-backend";
import { webMethod, Permissions } from "wix-web-module";
import { elevate } from "wix-auth";

// Cache the return value
export const cachedMultiply = webMethod(Permissions.Anyone, (a, b) => a * b, {
  cache: {
    tags: ["multiply", "math"],
    ttl: 604000,
  },
});


// Invalidate the cache
const invalidationMethods = [{ tag: "multiply" }, { tag: "math" }];
const elevatedInvalidateCache = elevate(cache.invalidateCache);

export const invalidateCache = webMethod(Permissions.Anyone, async () => {
  try {
    await elevatedInvalidateCache(invalidationMethods);
    console.log("Successfully invalidated cache.")
  } catch (error) {
    console.error(error);
    // Handle the error
  }
});

/* Promise resolves to void */

Cache the value returned from a function, then invalidate it 

import { cache } from "wix-cache-backend";
import { contacts } from "wix-crm.v2";
import { webMethod, Permissions } from "wix-web-module";
import { elevate } from "wix-auth";

// Query contacts and cache result
const elevatedQueryContact = elevate(contacts.queryContacts);

export const myQueryContactFunction = webMethod(
  Permissions.Anyone,
  async () => {
    try {
      const contact = await elevatedQueryContact().find();
      return contact.items;
    } catch (error) {
      console.log(error);
      // Handle the error
    }
  },
  {
    cache: {
      tags: ["contact", "crm"],
      ttl: 85500,
    },
  }
);



// Invalidate cached query return value
/* Sample invalidationMethods value:
 * [
 *   { tag: "contact" },
 *   { tag: "crm" }
 * ]
 */
const elevatedInvalidateCache = elevate(cache.invalidateCache);

export const invalidateCache = webMethod(
  Permissions.Anyone,
  async (invalidationMethods) => {
    try {
      await elevatedInvalidateCache(invalidationMethods);
      return console.log("Successfully invalidated cache.");
    } catch (error) {
      console.error(error);
      // Handle the error
    }
  }
);


Invalidate cached return value from queryContacts() @description:

invalidateCache

void

---
title: Introduction
---
# Introduction

<div style="background-color: #FEF1D1; padding: 18px 24px; border-radius: 6px; border: 1px solid #FDB10C; box-sizing: border-box; display: inline-block">
 Developer Preview
 
 APIs in <a href="https://www.wix.com/velo/reference/api-overview/developer-preview">Developer Preview</a> are subject to change and are not intended for use in production. <a href="mailto:velo-preview-feedback@wix.com">Send us</a> your suggestions for improving this API. Your feedback is valuable to us.
</div>

&nbsp;

Caching is a process that allows you to temporarily store data on Wix's infrastructure so it can be accessed faster, improving site performance. You can cache the return values of your backend function calls using the [`webMethod()`](https://dev.wix.com/docs/velo/api-reference/wix-web-module/web-method) function from the `wix-web-module`. The Cache API provides functionality for invalidating your backend function's caches. 

With the Cache API, you can invalidate the cached return values from your function calls, ensuring that your site displays the most current information. For instance, let's say you use the [`queryProducts()`](https://dev.wix.com/docs/velo/api-reference/wix-stores-v2/products/query-products) function and cache the response to display your products on your e-commerce site. If a product is discontinued, you should invalidate the cache to reflect this change. Once the cache is invalidated, it will be re-cached the next time the `queryProducts()` function is called. This prevents customers from attempting to purchase an item that is no longer available. 

Learn more about [cache invalidation](https://dev.wix.com/docs/develop-websites/articles/best-practices/caching/about-function-caching-in-the-backend#how-to-invalidate-a-function-cache).



To use the Cache API, import `cache` from the `wix-cache-backend` module:

```js
import { cache } from `wix-cache-backend`;
```


## Before you begin

You can invalidate your functions's cached return values that were previously defined with [tags](https://dev.wix.com/docs/velo/api-reference/wix-web-module/web-method) when cached. Your cache is automatically invalidated when: 
- The cache's time to live (TTL) expires.
- You republish your site with a code change. 

## Permissions information

Functions in the Cache API are restricted and only run if you elevate permissions using the `wix-auth` [`elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.

<blockquote class='warning'>
Warning: Elevating a function allows it to be called by any site visitor. Exercise caution to prevent security vulnerabilities.
</blockquote>

## Terminology
- **Return value cache:** API call return value that is temporarily stored on Wix's infrastructure. 
- **Tag:** Used to identify which cached return values to invalidate.