Interface: MessageClientOptions

Defined in: packages/messaging/src/sender.ts:102

Options for a MessageClient.

Properties

bus?

readonly optional bus?: InProcessBus

Defined in: packages/messaging/src/sender.ts:108

The in-process bus of this deployable. Omit when no module here is co-hosted.

---

caller

readonly caller: Participant

Defined in: packages/messaging/src/sender.ts:104

Who is calling: a module, gateway or bootstrap. Fixed by the caller's wiring.

---

clock?

readonly optional clock?: Clock

Defined in: packages/messaging/src/sender.ts:110

Defaults to the system clock.

---

defaultTimeoutMs?

readonly optional defaultTimeoutMs?: number

Defined in: packages/messaging/src/sender.ts:119

Default wait, in milliseconds. Defaults to 5000.

---

hosting?

readonly optional hosting?: HostingInput

Defined in: packages/messaging/src/sender.ts:123

The permission table and hosting map; defaults to the real estate.

---

logger?

readonly optional logger?: MessagingLogger

Defined in: packages/messaging/src/sender.ts:121

Defaults to a logger that discards.

---

newId?

readonly optional newId?: () => string

Defined in: packages/messaging/src/sender.ts:112

Mints message ids; defaults to UUID v7.

Returns

string

---

proveActor?

readonly optional proveActor?: ProveActor

Defined in: packages/messaging/src/sender.ts:117

The gateway's actor signer. Omitted by every other caller, whose calls carry the handled message's token on when they act for the same actor.

---

wire?

readonly optional wire?: BrokerWire

Defined in: packages/messaging/src/sender.ts:106

The broker. Omit in a process that only calls in process.