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): void;
        reply(value: R): void;
    }

    Type Parameters

    Index

    Properties

    Methods

    Properties

    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