Beignet API reference
    Preparing search index...

    Interface RedisEventBus

    Direct Redis event-bus adapter with explicit subscription cleanup.

    stop() detaches the message listener, cancels subscription retries, and releases channels subscribed by this adapter. The injected Redis clients remain caller-owned.

    interface RedisEventBus {
        publish<E extends DomainEventDef<string, StandardSchema>>(
            event: E,
            payload: InferEventPayload<E>,
            options?: EventPublishOptions,
        ): void | Promise<void>;
        stop(): Promise<void>;
        subscribe<E extends DomainEventDef<string, StandardSchema>>(
            event: E,
            handler: (
                payload: InferEventPayload<E>,
                options?: EventPublishOptions,
            ) => void | Promise<void>,
        ): EventSubscription;
    }

    Hierarchy (View Summary)

    Index
    publish stop subscribe

    • Stop local delivery and await cleanup of the adapter's channels without closing the caller-owned Redis clients.

      Returns Promise<void>

    Settings
    Member Visibility

    On This Page
    Methods