BroadcastOptions

Interface exported by @botmesh/core.

Defined in: ops/broadcast.ts:35

Options of bot.broadcast(): batching, pacing, retries on rate limits, progress callbacks and cancellation.

Properties

batchSize?

batchSize?: number;

Defined in: ops/broadcast.ts:37

Chats per batch (default 10).

---

delayBetween?

delayBetween?: string | number;

Defined in: ops/broadcast.ts:39

Pause between batches: ms or a duration string ('2s', '1m'). Default 0.

---

concurrency?

concurrency?: number;

Defined in: ops/broadcast.ts:41

Parallel sends inside a batch (default 1 — strictly sequential).

---

retries?

retries?: number;

Defined in: ops/broadcast.ts:46

Retries per chat AFTER the first attempt, on a RateLimitedError (default 3, so up to 4 sends). Other errors are not retried. Same meaning as every retries option.

---

maxRetries?

maxRetries?: number;

Defined in: ops/broadcast.ts:48

Deprecated

Use retries (same meaning).

---

sendOptions?

sendOptions?: SendOptions;

Defined in: ops/broadcast.ts:50

Options forwarded to every send (quoted, mentions, …).

---

onProgress?

onProgress?: (done, total, last) => void;

Defined in: ops/broadcast.ts:52

Called after each chat settles: (done, total, last). Errors thrown here are reported, never fatal.

Parameters

Parameter	Type
done	number
total	number
last	BroadcastProgress

Returns

void

---

onFail?

onFail?: (chatId, error) => void;

Defined in: ops/broadcast.ts:54

Called for each chat that finally failed. Errors thrown here are reported, never fatal.

Parameters

Parameter	Type
chatId	string
error	Error

Returns

void

---

signal?

signal?: AbortSignal;

Defined in: ops/broadcast.ts:56

Abort to stop: no new send starts; in-flight sends finish; the rest land in pending.