Interface: ClientEvents
types/events.ClientEvents
Properties
disconnected
• disconnected: () => void
Type declaration
▸ (): void
Fired on disconnect.
Returns
void
Defined in
message
• message: (message: Message) => void
Type declaration
▸ (message): void
Fired when a message is received.
Parameters
| Name | Type |
|---|---|
message | Message |
Returns
void
Defined in
nick-change
• nick-change: (nickChangeInfo: NickChangeInfo) => void
Type declaration
▸ (nickChangeInfo): void
Fired when someone changes their nickname.
Parameters
| Name | Type |
|---|---|
nickChangeInfo | NickChangeInfo |
Returns
void
Defined in
sys-message
• sys-message: (sysMessage: SysMessage<"info" | "error" | "success">) => void
Type declaration
▸ (sysMessage): void
Fired when any system message is received
Parameters
| Name | Type |
|---|---|
sysMessage | SysMessage<"info" | "error" | "success"> |
Returns
void
Defined in
sys-message-error
• sys-message-error: (sysMessage: SysMessage<"error">) => void
Type declaration
▸ (sysMessage): void
Fired when a system message is received of type error
Parameters
| Name | Type |
|---|---|
sysMessage | SysMessage<"error"> |
Returns
void
Defined in
sys-message-info
• sys-message-info: (sysMessage: SysMessage<"info">) => void
Type declaration
▸ (sysMessage): void
Fired when a system message is received of type info
Parameters
| Name | Type |
|---|---|
sysMessage | SysMessage<"info"> |
Returns
void
Defined in
sys-message-success
• sys-message-success: (sysMessage: SysMessage<"success">) => void
Type declaration
▸ (sysMessage): void
Fired when a system message is received of type success
Parameters
| Name | Type |
|---|---|
sysMessage | SysMessage<"success"> |
Returns
void
Defined in
tag-add
• tag-add: (tagAddInfo: TagAddInfo) => void
Type declaration
▸ (tagAddInfo): void
Fired when a user gets a new tag.
Parameters
| Name | Type |
|---|---|
tagAddInfo | TagAddInfo |
Returns
void
Defined in
user-join
• user-join: (user: User) => void
Type declaration
▸ (user): void
Fired when a user joins.
Parameters
| Name | Type |
|---|---|
user | User |
Returns
void
Defined in
user-leave
• user-leave: (user: User) => void
Type declaration
▸ (user): void
Fired when a user leaves.
Parameters
| Name | Type |
|---|---|
user | User |
Returns
void
Defined in
werror
• werror: (reason: string) => void
Type declaration
▸ (reason): void
Fired when a "GUI error" occurs. This is can be any error which doesn't disconnect you as a result.
Parameters
| Name | Type |
|---|---|
reason | string |
Returns
void