Class Client

Hierarchy

<internal>.EventEmitter
- Client

Index

Constructors

constructor

new Client(ops: { cloudstormOptions?: IClientOptions; snowtransferInstance?: <internal>.SnowTransfer; snowtransferOptions?: { baseHost: string; disableEveryone: boolean }; token: string }): Client

Overrides EventEmitter.constructor
- Defined in src/gateway/Client.ts:17
Parameters
- ops: { cloudstormOptions?: IClientOptions; snowtransferInstance?: <internal>.SnowTransfer; snowtransferOptions?: { baseHost: string; disableEveryone: boolean }; token: string }
  - Optional cloudstormOptions?: IClientOptions
  - Optional snowtransferInstance?: <internal>.SnowTransfer
  - Optional snowtransferOptions?: { baseHost: string; disableEveryone: boolean }
    - baseHost: string
    - disableEveryone: boolean
  - token: string
Returns Client

Properties

dmChannels

dmChannels: Collection<string, DMChannel>

gateway

gateway: Gateway

guilds

guilds: Collection<string, Guild>

rest

rest: <internal>.SnowTransfer

user

user: null | User

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

addListener(event: string | symbol, listener: ((...args: any[]) => void)): Client

Inherited from EventEmitter.addListener
- Defined in node_modules/@types/node/events.d.ts:11
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Client

emit

emit(event: string | symbol, ...args: any[]): boolean

Inherited from EventEmitter.emit
- Defined in node_modules/@types/node/events.d.ts:23
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): (string | symbol)[]

Inherited from EventEmitter.eventNames
- Defined in node_modules/@types/node/events.d.ts:24
Returns (string | symbol)[]

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners
- Defined in node_modules/@types/node/events.d.ts:20
Returns number

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:25
Parameters
- type: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Inherited from EventEmitter.listeners
- Defined in node_modules/@types/node/events.d.ts:21
Parameters
- event: string | symbol
Returns Function[]

login

login(): Promise<void>

- Defined in src/gateway/Client.ts:39
Returns Promise<void>

off

off(event: string | symbol, listener: ((...args: any[]) => void)): Client

Inherited from EventEmitter.off
- Defined in node_modules/@types/node/events.d.ts:17
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Client

on

on(event: string | symbol, listener: ((...args: any[]) => void)): Client

Inherited from EventEmitter.on
- Defined in node_modules/@types/node/events.d.ts:12
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Client

once

once(event: string | symbol, listener: ((...args: any[]) => void)): Client

Inherited from EventEmitter.once
- Defined in node_modules/@types/node/events.d.ts:13
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Client

prependListener

prependListener(event: string | symbol, listener: ((...args: any[]) => void)): Client

Inherited from EventEmitter.prependListener
- Defined in node_modules/@types/node/events.d.ts:14
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Client

prependOnceListener

prependOnceListener(event: string | symbol, listener: ((...args: any[]) => void)): Client

Inherited from EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/events.d.ts:15
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Client

rawListeners

rawListeners(event: string | symbol): Function[]

Inherited from EventEmitter.rawListeners
- Defined in node_modules/@types/node/events.d.ts:22
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): Client

Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/@types/node/events.d.ts:18
Parameters
- Optional event: string | symbol
Returns Client

removeListener

removeListener(event: string | symbol, listener: ((...args: any[]) => void)): Client

Inherited from EventEmitter.removeListener
- Defined in node_modules/@types/node/events.d.ts:16
Parameters
- event: string | symbol
- listener: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Client

setMaxListeners

setMaxListeners(n: number): Client

Inherited from EventEmitter.setMaxListeners
- Defined in node_modules/@types/node/events.d.ts:19
Parameters
- n: number
Returns Client

Static listenerCount

listenerCount(emitter: <internal>.EventEmitter, event: string | symbol): number

Inherited from EventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:8
deprecated
since v4.0.0

Parameters
- emitter: <internal>.EventEmitter
- event: string | symbol
Returns number

Generated using TypeDoc