Interface OutboxDispatcherOptions

What an OutboxDispatcher sends from, where to, and how.

interface OutboxDispatcherOptions {
    outbox: IOutbox;
    resolve: ((destinationRef) => Promise<undefined | DeliveryDestination>);
    send?: DeliverySend;
    mail?: MailSend;
    names?: EnvelopeHeaderNames;
    clock?: IClock;
    batch?: number;
    timeoutMs?: number;
    logger?: {
        warn(msg): void;
    };
}

Properties

outbox resolve send? mail? names? clock? batch? timeoutMs? logger?

Properties

outbox

outbox: IOutbox

The outbox whose due deliveries it sends; one dispatcher per outbox.

resolve

resolve: ((destinationRef) => Promise<undefined | DeliveryDestination>)

A delivery's destination by its destinationRef, or undefined when the host no longer holds it.

Type declaration

Optional send

send?: DeliverySend

How each delivery is posted; httpsSend when absent.

Optional mail

mail?: MailSend

Sends a delivery of kind mail; absent, such a delivery fails for its backoff and the warning names it. With it, the outbox needs markDead, so an unknown outcome can end its delivery rather than retry a send the destination may have made.

Optional names

names?: EnvelopeHeaderNames

The envelope's header names; the library's defaults when absent.

Optional clock

clock?: IClock

What is due, and the envelope's timestamp, by this clock; the wall clock when absent.

Optional batch

batch?: number

Deliveries a pass takes. Default 50.

Optional timeoutMs

timeoutMs?: number

Each post's deadline. Default 10000.

Optional logger

logger?: {
    warn(msg): void;
}

Told a failed delivery's id and the error's name, never its body, its url or its secret.

Type declaration

Settings

Member Visibility

Theme

On This Page

outboxresolvesendmailnamesclockbatchtimeoutMslogger