Client <Ready>

Hierarchy

• EventEmitter
  • Client

Index

Constructors

• constructor

Properties

• cdn
• channels
• guilds
• options
• ready
• rest
• users

Accessors

• user

Methods

• connect
• emit
• login
• off
• on

Constructors

constructor

• new Client<Ready>(options: ClientOptions): Client<Ready>

• Type parameters

  • Ready: boolean = boolean

Properties

publiccdn

cdn: CDN = ...

The CDN handler for this client

publicchannels

channels: Map<string, Channel> = ...

All channels that are currently cached

publicguilds

guilds: Map<string, Guild> = ...

All guilds that are currently cached

publicoptions

options: ClientOptions

The options for this client

publicready

ready: Ready = ...

publicrest

rest: RestAPIHandler = ...

The rest API handler for this client

publicusers

users: Map<string, User> = ...

All users that are currently cached

Accessors

publicuser

• get user(): ClientUser
• set user(user: ClientUser): void

• The user used to log in

Methods

publicconnect

• connect(token: string): Promise<void>

• Connect to the Discord gateway

emit

• emit<E>(eventName: E, ...args: ClientEvents[E]): boolean

• Type parameters

  • E: keyof ClientEvents

publiclogin

• login(token: string): Promise<void>

• Connect to the Discord gateway

  @deprecated

  Use Client.connect instead

off

• off<E>(eventName: E, listener: (...args: ClientEvents[E]) => void): Client<Ready>

• Type parameters

  • E: keyof ClientEvents

on

• on<E>(eventName: E, listener: (...args: ClientEvents[E]) => void): Client<Ready>

• Type parameters

  • E: keyof ClientEvents