Developer Preview — This project is in active development. APIs may change. Provide feedback
Skip to content

@salesforce/b2c-tooling-sdk / operations/mrt / invalidateCache

Function: invalidateCache()

invalidateCache(options, auth): Promise<InvalidateCacheResult>

Defined in: packages/b2c-tooling-sdk/src/operations/mrt/cache.ts:94

Invalidates cached objects in the CDN for an MRT environment.

Cache invalidations are asynchronous and usually complete within two minutes.

Parameters

options

InvalidateCacheOptions

Invalidation options

auth

AuthStrategy

Authentication strategy (ApiKeyStrategy)

Returns

Promise<InvalidateCacheResult>

Invalidation result

Throws

Error if request fails

Example

typescript
import { ApiKeyStrategy } from '@salesforce/b2c-tooling-sdk/auth';
import { invalidateCache } from '@salesforce/b2c-tooling-sdk/operations/mrt';

const auth = new ApiKeyStrategy(process.env.MRT_API_KEY!, 'Authorization');

// Invalidate all cached paths
const result = await invalidateCache({
  projectSlug: 'my-storefront',
  targetSlug: 'production',
  pattern: '/*'
}, auth);

console.log(result.result);

// Invalidate specific path
const result2 = await invalidateCache({
  projectSlug: 'my-storefront',
  targetSlug: 'production',
  pattern: '/products/*'
}, auth);

Released under the Apache-2.0 License.