Sanity Library Reference Docs
    Preparing search index...

    Interface MessageBusClient

    The host's handle to one connection: who it is, when it closes, and where to write its state.

    interface MessageBusClient {
        appId: string;
        closed: AbortSignal;
        moduleId: string;
        emit<K extends StateTopic>(type: K, value: ValueOf<K>): void;
    }
    Index

    Properties

    Methods

    Properties

    appId: string

    The application the connection belongs to.

    closed: AbortSignal

    Aborts when the connection disconnects. Drop per-client state here.

    moduleId: string

    The federation module id of the connection. Equals appId when the host supplied none.

    Methods