Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MoonlightClient

Getting started with Moonlight

// TO BE COMPLETED

license

MIT

Hierarchy

  • Client
    • MoonlightClient

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Readonly aliases

aliases: Map<string, string> = ...

A map which stores all command aliases

channels

channels: ChannelManager

Readonly commands

commands: CommandPool<string, Command> = ...

The command pool that stores all commands

Readonly coreDir

coreDir: string = ...

The core directory, where the Moonlight files are located

Readonly emojis

emojis: GuildEmojiManager

Readonly events

events: EventPool<string, Event> = ...

The event pool that stores all events

guilds

guilds: GuildManager

mainDir

mainDir: string = ...

The user's directory

Readonly monitors

monitors: MonitorPool<string, Monitor> = ...

The monitor pool that stores all monitors

options

options: MoonlightClientOptions

owners

owners: string[] = ...

An array of owners

Readonly prefixes

prefixes: string[] = ...

An array containing all the prefixes

readyAt

readyAt: null | Date

Readonly readyTimestamp

readyTimestamp: null | number

shard

shard: null | ShardClientUtil

Readonly tasks

tasks: TaskPool<string, Task> = ...

The task pool that stores all tasks

token

token: null | string

Readonly uptime

uptime: null | number

user

user: null | ClientUser

users

users: UserManager

voice

voice: null | ClientVoiceManager

ws

ws: WebSocketManager

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Accessors

pools

Methods

addListener

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Client

clearImmediate

  • clearImmediate(timeout: Immediate): void

  • Parameters

    • timeout: Immediate

    Returns void

clearInterval

  • clearInterval(interval: Timeout): void

  • Parameters

    • interval: Timeout

    Returns void

clearTimeout

  • clearTimeout(timeout: Timeout): void

  • Parameters

    • timeout: Timeout

    Returns void

destroy

  • destroy(): void

  • Returns void

emit

  • emit<K>(event: K, ...args: ClientEvents[K]): boolean
  • emit<S>(event: Exclude<S, keyof ClientEvents>, ...args: any[]): boolean

  • Type parameters

    • K: keyof ClientEvents

    Parameters

    • event: K
    • Rest ...args: ClientEvents[K]

    Returns boolean

  • Type parameters

    • S: string | symbol

    Parameters

    • event: Exclude<S, keyof ClientEvents>
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]

  • Returns (string | symbol)[]

fetchApplication

  • fetchApplication(): Promise<ClientApplication>

  • Returns Promise<ClientApplication>

fetchGuildPreview

  • fetchGuildPreview(guild: GuildResolvable): Promise<GuildPreview>

  • Parameters

    • guild: GuildResolvable

    Returns Promise<GuildPreview>

fetchGuildTemplate

  • fetchGuildTemplate(template: string): Promise<GuildTemplate>

  • Parameters

    • template: string

    Returns Promise<GuildTemplate>

fetchInvite

  • fetchInvite(invite: string): Promise<Invite>

  • Parameters

    • invite: string

    Returns Promise<Invite>

fetchVoiceRegions

  • fetchVoiceRegions(): Promise<Collection<string, VoiceRegion>>

  • Returns Promise<Collection<string, VoiceRegion>>

fetchWebhook

  • fetchWebhook(id: string, token?: string): Promise<Webhook>

  • Parameters

    • id: string
    • Optional token: string

    Returns Promise<Webhook>

generateInvite

  • generateInvite(options?: InviteGenerationOptions | PermissionResolvable): Promise<string>

  • Parameters

    • Optional options: InviteGenerationOptions | PermissionResolvable

    Returns Promise<string>

getMaxListeners

  • getMaxListeners(): number

  • Returns number

listenerCount

  • listenerCount(event: string | symbol): number

  • Parameters

    • event: string | symbol

    Returns number

listeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

login

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

  • The function that initiates the bot and then logs the client in, establishing a websocket connection to Discord.

    example(client.login('token'))

    Parameters

    • Optional token: string

      Token of the bot account to log in with

    Returns Promise<string>

    Token

off

  • off<K>(event: K, listener: (...args: ClientEvents[K]) => void): Client
  • off<S>(event: Exclude<S, keyof ClientEvents>, listener: (...args: any[]) => void): Client

  • Type parameters

    • K: keyof ClientEvents

    Parameters

    • event: K
    • listener: (...args: ClientEvents[K]) => void
        • (...args: ClientEvents[K]): void

        • Parameters

          • Rest ...args: ClientEvents[K]

          Returns void

    Returns Client

  • Type parameters

    • S: string | symbol

    Parameters

    • event: Exclude<S, keyof ClientEvents>
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Client

on

  • on<K>(event: K, listener: (...args: ClientEvents[K]) => void): Client
  • on<S>(event: Exclude<S, keyof ClientEvents>, listener: (...args: any[]) => void): Client

  • Type parameters

    • K: keyof ClientEvents

    Parameters

    • event: K
    • listener: (...args: ClientEvents[K]) => void
        • (...args: ClientEvents[K]): void

        • Parameters

          • Rest ...args: ClientEvents[K]

          Returns void

    Returns Client

  • Type parameters

    • S: string | symbol

    Parameters

    • event: Exclude<S, keyof ClientEvents>
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Client

once

  • once<K>(event: K, listener: (...args: ClientEvents[K]) => void): Client
  • once<S>(event: Exclude<S, keyof ClientEvents>, listener: (...args: any[]) => void): Client

  • Type parameters

    • K: keyof ClientEvents

    Parameters

    • event: K
    • listener: (...args: ClientEvents[K]) => void
        • (...args: ClientEvents[K]): void

        • Parameters

          • Rest ...args: ClientEvents[K]

          Returns void

    Returns Client

  • Type parameters

    • S: string | symbol

    Parameters

    • event: Exclude<S, keyof ClientEvents>
    • 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

  • 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

  • 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[]

  • Parameters

    • event: string | symbol

    Returns Function[]

removeAllListeners

  • removeAllListeners<K>(event?: K): Client
  • removeAllListeners<S>(event?: Exclude<S, keyof ClientEvents>): Client

  • Type parameters

    • K: keyof ClientEvents

    Parameters

    • Optional event: K

    Returns Client

  • Type parameters

    • S: string | symbol

    Parameters

    • Optional event: Exclude<S, keyof ClientEvents>

    Returns Client

removeListener

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Client

setImmediate

  • setImmediate(fn: (...args: any[]) => void, ...args: any[]): Immediate

  • Parameters

    • fn: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    • Rest ...args: any[]

    Returns Immediate

setInterval

  • setInterval(fn: (...args: any[]) => void, delay: number, ...args: any[]): Timeout

  • Parameters

    • fn: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    • delay: number
    • Rest ...args: any[]

    Returns Timeout

setMaxListeners

  • setMaxListeners(n: number): Client

  • Parameters

    • n: number

    Returns Client

setTimeout

  • setTimeout(fn: (...args: any[]) => void, delay: number, ...args: any[]): Timeout

  • Parameters

    • fn: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    • delay: number
    • Rest ...args: any[]

    Returns Timeout

sweepMessages

  • sweepMessages(lifetime?: number): number

  • Parameters

    • Optional lifetime: number

    Returns number

toJSON

  • toJSON(): object

  • Returns object

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • deprecated

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Static on

  • on(emitter: EventEmitter, event: string): AsyncIterableIterator<any>

  • Parameters

    • emitter: EventEmitter
    • event: string

    Returns AsyncIterableIterator<any>

Static once

  • once(emitter: NodeEventTarget, event: string | symbol): Promise<any[]>
  • once(emitter: DOMEventTarget, event: string): Promise<any[]>

  • Parameters

    • emitter: NodeEventTarget
    • event: string | symbol

    Returns Promise<any[]>

  • Parameters

    • emitter: DOMEventTarget
    • event: string

    Returns Promise<any[]>

Generated using TypeDoc