Client

interface

Client

source
export interface Client<Ready extends boolean> extends Client$1<Ready>
export interface Client<Ready extends boolean> extends Client$1<Ready>

.on(...)

on<E extends keyof Client.Events>(event: E, listener: ((...args: Client.Events[E])) => Awaitable<void>): this
on<E extends keyof Client.Events>(event: E, listener: ((...args: Client.Events[E])) => Awaitable<void>): this
ParamTypeRequired
event
event
E
E
Yes
listener
listener
((...args: Client.Events[E])) => Awaitable<void>
((...args: Client.Events[E])) => Awaitable<void>
Yes

Returns:

this
this

once<E extends keyof Client.Events>(event: E, listener: ((...args: Client.Events[E])) => Awaitable<void>): this
once<E extends keyof Client.Events>(event: E, listener: ((...args: Client.Events[E])) => Awaitable<void>): this
ParamTypeRequired
event
event
E
E
Yes
listener
listener
((...args: Client.Events[E])) => Awaitable<void>
((...args: Client.Events[E])) => Awaitable<void>
Yes

Returns:

this
this

emit<E extends keyof Client.Events>(event: E, ...args: Client.Events[E]): boolean
emit<E extends keyof Client.Events>(event: E, ...args: Client.Events[E]): boolean
ParamTypeRequired
event
event
E
E
Yes
...args
...args
Client.Events[E]
Client.Events[E]
No

Returns:

boolean
boolean

.off(...)

off<E extends keyof Client.Events>(event: E, listener: ((...args: Client.Events[E])) => Awaitable<void>): this
off<E extends keyof Client.Events>(event: E, listener: ((...args: Client.Events[E])) => Awaitable<void>): this
ParamTypeRequired
event
event
E
E
Yes
listener
listener
((...args: Client.Events[E])) => Awaitable<void>
((...args: Client.Events[E])) => Awaitable<void>
Yes

Returns:

this
this

removeAllListeners<E extends keyof Client.Events>(event?: E): this
removeAllListeners<E extends keyof Client.Events>(event?: E): this
ParamTypeRequired
event
event
E
E
No

Returns:

this
this

removeListener<E extends keyof Client.Events>(event: E, listener: Function): this
removeListener<E extends keyof Client.Events>(event: E, listener: Function): this
ParamTypeRequired
event
event
E
E
Yes
listener
listener
Function
Function
Yes

Returns:

this
this

isReady(): this is Client<true>
isReady(): this is Client<true>

Returns:

this is Client<true>
this is Client<true>