BroadcastResult

Interface exported by @botmesh/core.

Defined in: ops/broadcast.ts:74

What bot.broadcast() resolves to: counts, failures and the accepted sends.

Properties

total

total: number;

Defined in: ops/broadcast.ts:76

Distinct chats targeted (duplicate ids are sent once).

---

sent

sent: number;

Defined in: ops/broadcast.ts:78

Chats the provider accepted.

---

failed

failed: number;

Defined in: ops/broadcast.ts:80

Chats whose send failed for good.

---

skipped

skipped: number;

Defined in: ops/broadcast.ts:82

Chats a before('send') hook skipped (counted neither as sent nor failed).

---

errors

errors: BroadcastFailure[];

Defined in: ops/broadcast.ts:83

---

messages

messages: SentMessage<unknown>[];

Defined in: ops/broadcast.ts:85

The accepted sends, in completion order.

---

cancelled

cancelled: boolean;

Defined in: ops/broadcast.ts:87

true when signal aborted the broadcast before every chat was attempted.

---

pending

pending: string[];

Defined in: ops/broadcast.ts:89

Chats never attempted because of the abort.