SendQueue

Defined in: packages/client/src/messages/send-queue.ts:45

The only path to the air: paces transmissions, waits for DM acknowledgements, resends and floods, expires messages the radio never got to.

Constructors

Constructor

new SendQueue(client): SendQueue;

Defined in: packages/client/src/messages/send-queue.ts:57

Parameters

client

Client

Owning client

Returns

SendQueue

Accessors

idle

Get Signature

get idle(): boolean;

Defined in: packages/client/src/messages/send-queue.ts:65

Returns

boolean

size

Get Signature

get size(): number;

Defined in: packages/client/src/messages/send-queue.ts:61

Returns

number

Methods

budgetFor()

budgetFor(target, prefix?): number;

Defined in: packages/client/src/messages/send-queue.ts:73

Parameters

target

Contact | Channel

Contact or channel

prefix?

string = ''

Text counted in the budget, like a mention

Returns

number

close()

close(timeoutMs): Promise<void>;

Defined in: packages/client/src/messages/send-queue.ts:124

Parameters

timeoutMs

number

Time left to flush the queue

Returns

Promise<void>

send()

send(
   target, 
   content, 
   options?
): Promise<SentMessage>;

Defined in: packages/client/src/messages/send-queue.ts:82

Parameters

target

Contact | Channel

Contact or channel

content

MessageContent

Text or MessageBuilder

options?

SendOptions = {}

mention prefix for channel replies

Returns

Promise<SentMessage>