Sanity Library Reference Docs
    Preparing search index...

    Interface MessageBus<TTopics>

    Sends events and reads typed state and event topics.

    State topics are written by the host to each connection separately through MessageBusClient.emit; a connection only ever reads its own values.

    interface MessageBus<TTopics = MessageBusTopics> {
        emit<K extends string | number | symbol>(
            type: K,
            ...rest: PayloadOf<K, TTopics> extends void
                ? [payload?: void, options?: MessageBusEmitOptions]
                : [payload: PayloadOf<K, TTopics>, options?: MessageBusEmitOptions],
        ): MessageBusEmitResult<ReplyOf<K, TTopics>>;
        query<K extends string | number | symbol>(
            type: K,
            options?: MessageBusQueryOptions,
        ): Promise<ValueOf<K, TTopics>>;
        subscribe<K extends string | number | symbol>(
            type: K,
            handler: (
                message: MessageBusMessage<
                    PayloadOf<K, TTopics>,
                    ReplyOf<K, TTopics>,
                    K,
                >,
            ) => void,
            options?: MessageBusAbortOptions,
        ): void;
        subscribe<K extends string | number | symbol>(
            type: K,
            handler: (value: ValueOf<K, TTopics>) => void,
            options?: MessageBusAbortOptions,
        ): void;
        subscribe<K extends string | number | symbol>(
            type: K,
        ): MessageBusStateSource<ValueOf<K, TTopics>>;
        subscribe<K extends string | number | symbol>(
            type: K,
        ): Observable<PayloadOf<K, TTopics>>;
    }

    Type Parameters

    • TTopics = MessageBusTopics

    Hierarchy (View Summary)

    Index

    Methods

    emit query subscribe

    Methods

    Settings

    Member Visibility

    On This Page

    Methods