TestBot
Defined in: packages/testing/src/test-client.ts:27
A logged-in bot on a fake radio with simulated time: send it DMs and channel messages, read what it put on the air, advance the clock, and destroy it.
Properties
client
readonly client: Client;Defined in: packages/testing/src/test-client.ts:28
clock
readonly clock: Clock;Defined in: packages/testing/src/test-client.ts:31
radio
readonly radio: FakeRadio;Defined in: packages/testing/src/test-client.ts:29
transport
readonly transport: MockTransport;Defined in: packages/testing/src/test-client.ts:30
Methods
advanceTime()
advanceTime(duration): Promise<void>;Defined in: packages/testing/src/test-client.ts:61
Parameters
duration
string | number
Milliseconds, or a string like 30s, 5m, 1h, 1d
Returns
Promise<void>
channel()
channel(
channelName,
authorName,
text
): Promise<string[]>;Defined in: packages/testing/src/test-client.ts:57
Parameters
channelName
string
Channel name
authorName
string
Sender name
text
string
Message text
Returns
Promise<string[]>
destroy()
destroy(): Promise<void>;Defined in: packages/testing/src/test-client.ts:64
Returns
Promise<void>
dm()
dm(from, text): Promise<string[]>;Defined in: packages/testing/src/test-client.ts:51
Parameters
from
string | Contact
Contact or its name
text
string
Message text
Returns
Promise<string[]>
fakeChannel()
fakeChannel(name, secret?): Channel;Defined in: packages/testing/src/test-client.ts:41
Parameters
name
string
Channel name
secret?
Uint8Array<ArrayBufferLike>
16 bytes, derived from the name when omitted
Returns
Channel
fakeContact()
fakeContact(name, overrides?): Contact;Defined in: packages/testing/src/test-client.ts:36
Parameters
name
string
Contact name, the key is derived from it
overrides?
Partial<ContactRecord>
Contact record fields
Returns
Contact
sentTo()
sentTo(target): string[];Defined in: packages/testing/src/test-client.ts:63
Parameters
target
string
Channel name, contact name or key prefix
Returns
string[]
setRoleMembers()
setRoleMembers(role, members): void;Defined in: packages/testing/src/test-client.ts:46
Parameters
role
string
Role name
members
(string | Contact)[]
Contacts or public keys
Returns
void
setTime()
setTime(date): Promise<void>;Defined in: packages/testing/src/test-client.ts:59
Parameters
date
string | number | Date
New simulated time
Returns
Promise<void>