Sanity Library Reference Docs
    Preparing search index...

    Interface MessageBusMessage<T, R, K>

    A message delivered to an event topic responder.

    interface MessageBusMessage<T, R = never, K extends PropertyKey = TopicName> {
        meta: MessageBusMeta;
        payload: T;
        signal: AbortSignal;
        type: K;
        reject(
            message?: string,
            code?: "NO_RESPONDER" | "HANDLER_THREW" | "REFUSED",
            details?: MessageBusErrorDetails,
        ): void;
        reply(value: R): void;
    }

    Type Parameters

    Index

    Properties

    meta payload signal type

    Methods

    reject reply

    Properties

    meta: MessageBusMeta

    The message provenance.

    payload: T

    The event payload.

    signal: AbortSignal

    Aborts when the sender stops waiting for a reply.

    type: K

    The topic that carries the message.

    Methods

    • Refuses the message: the sender's awaited emit() rejects with a MessageBusError whose code is code, 'REFUSED' by default. A host that passes the message on refuses with 'NO_RESPONDER' when nothing can answer it, and with 'HANDLER_THREW' when what it passed the message to threw. Ignored, with a warning, once the reply has already settled. details reach the sender as the error's fix and docsUrl, when the sender's copy of the SDK knows them; an older one gets the code and message only.

      Parameters

      • Optionalmessage: string
      • Optionalcode: "NO_RESPONDER" | "HANDLER_THREW" | "REFUSED"
      • Optionaldetails: MessageBusErrorDetails

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods