Client
Defined in: packages/client/src/client/client.ts:69
A bot: logs into a Companion radio over a Transport, keeps contact and channel caches, turns radio messages
into Message objects and runs the registered bricks. Takes infrastructure only (transport, radio config,
replies, logger); bot content comes from builders through register() / load().
Extends
Constructors
Constructor
new Client(options): Client;Defined in: packages/client/src/client/client.ts:100
Parameters
options
Transport and optional radio config, replies, logger, app name and load directory
Returns
Client
Overrides
Properties
channels
readonly channels: ChannelManager;Defined in: packages/client/src/client/client.ts:74
commands
readonly commands: CommandManager;Defined in: packages/client/src/client/client.ts:76
contacts
readonly contacts: ContactManager;Defined in: packages/client/src/client/client.ts:73
events
readonly events: EventManager;Defined in: packages/client/src/client/client.ts:77
jobs
readonly jobs: JobManager;Defined in: packages/client/src/client/client.ts:78
logger
readonly logger: Logger;Defined in: packages/client/src/client/client.ts:71
permissions
readonly permissions: PermissionManager;Defined in: packages/client/src/client/client.ts:79
plugins
readonly plugins: PluginManager;Defined in: packages/client/src/client/client.ts:81
radio
readonly radio: Radio;Defined in: packages/client/src/client/client.ts:72
radioConfig
readonly radioConfig: RadioConfig | null;Defined in: packages/client/src/client/client.ts:83
replies
readonly replies: Replies;Defined in: packages/client/src/client/client.ts:82
roles
readonly roles: RoleManager;Defined in: packages/client/src/client/client.ts:80
sendQueue
readonly sendQueue: SendQueue;Defined in: packages/client/src/client/client.ts:75
transport
readonly transport: Transport;Defined in: packages/client/src/client/client.ts:70
Accessors
device
Get Signature
get device(): DeviceInfo;Defined in: packages/client/src/client/client.ts:139
Returns
isReady
Get Signature
get isReady(): boolean;Defined in: packages/client/src/client/client.ts:130
Returns
boolean
self
Get Signature
get self(): SelfInfo;Defined in: packages/client/src/client/client.ts:134
Returns
status
Get Signature
get status(): ClientStatus;Defined in: packages/client/src/client/client.ts:126
Returns
Methods
_reportError()
_reportError(error, source): void;Defined in: packages/client/src/client/client.ts:211
Parameters
error
unknown
source
Returns
void
destroy()
destroy(): Promise<void>;Defined in: packages/client/src/client/client.ts:199
Returns
Promise<void>
emit()
emit<K>(event, ...args): boolean;Defined in: packages/transports/src/typed-emitter.ts:44
Type Parameters
K
K extends string
Parameters
event
K
Event name
args
...ClientEvents[K]
Event arguments
Returns
boolean
Inherited from
listenerCount()
listenerCount<K>(event): number;Defined in: packages/transports/src/typed-emitter.ts:49
Type Parameters
K
K extends string
Parameters
event
K
Event name
Returns
number
Inherited from
load()
load(directory, options?): Promise<void>;Defined in: packages/client/src/client/client.ts:155
Parameters
directory
string | URL
Folder to scan, or a module path standing for its folder
options?
LoadOptions = {}
watch enables hot reload
Returns
Promise<void>
login()
login(): Promise<void>;Defined in: packages/client/src/client/client.ts:163
Returns
Promise<void>
off()
off<K>(event, listener): this;Defined in: packages/transports/src/typed-emitter.ts:35
Type Parameters
K
K extends string
Parameters
event
K
Event name
listener
Listener<ClientEvents[K]>
Listener to remove
Returns
this
Inherited from
on()
on<K>(event, listener): this;Defined in: packages/transports/src/typed-emitter.ts:17
Type Parameters
K
K extends string
Parameters
event
K
Event name
listener
Listener<ClientEvents[K]>
Called with the event arguments
Returns
this
Inherited from
once()
once<K>(event, listener): this;Defined in: packages/transports/src/typed-emitter.ts:26
Type Parameters
K
K extends string
Parameters
event
K
Event name
listener
Listener<ClientEvents[K]>
Called once with the event arguments
Returns
this
Inherited from
register()
register(bricks): this;Defined in: packages/client/src/client/client.ts:145
Parameters
bricks
| Brick<unknown>
| Brick<unknown>[]
One builder or a list
Returns
this
removeAllListeners()
removeAllListeners<K>(event?): this;Defined in: packages/transports/src/typed-emitter.ts:54
Type Parameters
K
K extends string
Parameters
event?
K
Event name, or every event when omitted
Returns
this