invalidateCache( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Important: This API is only supported for developing sites and works only when used together with the Web Methods or Router APIs.

Invalidates or clears previously cached return values based on specified tags.

The invalidationMethods parameter accepts an array of objects, each containing a tag field. These tags are defined when caching return values of site web methods and routers.

For example, an array such as [{ tag: "contacts" }, { tag: "labels" }] will clear any cached return values tagged with "contacts" or "labels."

Any cache containing at least one tag specified in the invalidationMethods parameter will be cleared.

Notes:

  • If you don't specify any tags in the invalidationMethods parameter, no caches are invalidated.
  • If you don't call Invalidate Cache, caches are only invalidated when the Time to Live (TTL) expires or when the site is republished with a code change.
  • This method does not invalidate the Server Side Rendering (SSR) cache for your site. To invalidate that cache, use the Invalidate Cache method from the wix-site-backend module.
Method Declaration
Copy
Method Parameters
invalidationMethodsArray<InvalidationMethods>Required

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.

Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?