Skip to main content

Interface: CacheInvalidatedEventData

Defined in: shared/types/events.ts:422

Payload for cache invalidation events.

Remarks​

Used to notify listeners that a cache entry or the entire cache has been invalidated for a specific reason.

Example​

// Invalidate all site caches due to manual action

const event: CacheInvalidatedEventData = {
    type: "all",
    reason: "manual",
    timestamp: Date.now(),
};

Hierarchy​

View Summary

Extends​

Indexable​

[key: string]: unknown
[key: number]: unknown
[key: symbol]: unknown

Properties​

timestamp​

readonly timestamp: number;

Defined in: shared/types/events.ts:104

The time (in milliseconds since epoch) when the event occurred.

Inherited from​

BaseEventData.timestamp

_meta?​

readonly optional _meta?: EventMetadata;

Defined in: shared/types/events.ts:106

Runtime metadata describing the emission context.

Inherited from​

BaseStateSyncEventData._meta

_originalMeta?​

readonly optional _originalMeta?: EventMetadata;

Defined in: shared/types/events.ts:108

Preserves previously attached metadata when re-emitting events.

Inherited from​

BaseStateSyncEventData._originalMeta

identifier?​

readonly optional identifier?: string;

Defined in: shared/types/events.ts:429

The specific identifier affected (optional for global invalidation).

Remarks​

If omitted, the invalidation is considered global.

reason​

readonly reason: CacheInvalidationReason;

Defined in: shared/types/events.ts:436

The reason for invalidation.

Remarks​

See CACHE_INVALIDATION_REASON for the complete list.

type​

readonly type: CacheInvalidationType;

Defined in: shared/types/events.ts:443

The type of cache invalidation.

Remarks​

See CACHE_INVALIDATION_TYPE for the complete list.