Member Junction
    Preparing search index...

    Interface CacheBroadcastProviderConfig

    Configuration options for the cache invalidation broadcast subsystem. Configured under cacheSettings.broadcast in mj.config.cjs or via MJ_CACHE_BROADCAST_* env vars.

    interface CacheBroadcastProviderConfig {
        awsIoTCore?: {
            accessKeyId?: string;
            endpoint?: string;
            region?: string;
            secretAccessKey?: string;
            tokenTtlSeconds?: number;
            topicPrefix?: string;
        };
        azureWebPubSub?: {
            accessKey?: string;
            endpoint?: string;
            hubName?: string;
            tokenTtlMinutes?: number;
        };
        excludedEntities?: string[];
        gcpPubSub?: {
            gatewayUrl?: string;
            projectId?: string;
            signingSecret?: string;
            tokenTtlSeconds?: number;
            topicPrefix?: string;
        };
        provider?: string;
        ringBufferSize?: number;
    }
    Index

    Properties

    awsIoTCore? azureWebPubSub? excludedEntities? gcpPubSub? provider? ringBufferSize?

    Properties

    awsIoTCore?: {
        accessKeyId?: string;
        endpoint?: string;
        region?: string;
        secretAccessKey?: string;
        tokenTtlSeconds?: number;
        topicPrefix?: string;
    }

    AWS IoT Core MQTT over WebSockets configuration (used when provider === 'AWSIoTCore').

    azureWebPubSub?: {
        accessKey?: string;
        endpoint?: string;
        hubName?: string;
        tokenTtlMinutes?: number;
    }

    Azure Web PubSub configuration (used when provider === 'AzureWebPubSub').

    excludedEntities?: string[]

    Optional list of entity names whose cache invalidation broadcasts should be suppressed (e.g., high-churn telemetry/audit tables never cached on the client).

    gcpPubSub?: {
        gatewayUrl?: string;
        projectId?: string;
        signingSecret?: string;
        tokenTtlSeconds?: number;
        topicPrefix?: string;
    }

    Google Cloud Pub/Sub / Cloud Run WebSockets configuration (used when provider === 'GCPPubSub').

    provider?: string

    Driver key registered with @RegisterClass(BaseCacheInvalidationBroadcastProvider, key). Defaults to 'SequencedRoleBucket'.

    ringBufferSize?: number

    Maximum number of sequenced invalidation events retained in the in-memory ring buffer for catch-up delta queries (GetCacheInvalidationsSince). Defaults to 5000.

    Settings

    Member Visibility

    On This Page

    Properties