vapor-chamber API reference - v1.16.0
    Preparing search index...

    Type Alias EchoBridgeOptions

    type EchoBridgeOptions = {
        echo: any;
        channels: EchoSubscription[];
        onBroadcast?: (
            info: { channel: string; event: string; payload: any },
            bus: BaseBus,
        ) => void;
        presenceEvents?: boolean;
    }
    Index
    echo: any

    A configured laravel-echo instance (or any object exposing channel(name) / private(name) / join(name) and leave(name)). The bridge takes your app's Echo so it never imports laravel-echo itself — keeping vapor-chamber backend-agnostic and the dependency out of the bundle.

    channels: EchoSubscription[]

    Channels + events to subscribe on install.

    onBroadcast?: (
        info: { channel: string; event: string; payload: any },
        bus: BaseBus,
    ) => void

    Map an incoming broadcast to the bus. Default: bus.emit(event, payload) so on(event) listeners fire. Provide this to dispatch a command instead, or to rename/drop events.

    presenceEvents?: boolean

    For presence channels, also emit membership changes as bus events "<name>:here", "<name>:joining", "<name>:leaving". Default: true.