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> = new Map<string, string>()

A map which stores all command aliases

channels

channels: ChannelManager

Readonly commands

commands: CommandPool<string, Command> = new CommandPool(this)

The command pool that stores all commands

Readonly coreDir

coreDir: string = path.join(__dirname, '../')

The core directory, where the Moonlight files are located

Readonly emojis

emojis: GuildEmojiManager

Readonly events

events: EventPool<string, Event> = new EventPool(this)

The event pool that stores all events

guilds

guilds: GuildManager

mainDir

mainDir: string = path.dirname(require.main!.filename)

The user's directory

Readonly monitors

monitors: MonitorPool<string, Monitor> = new MonitorPool(this)

The monitor pool that stores all monitors

options

options: MoonlightClientOptions

owners

owners: string[] = new Array()

An array of owners

Readonly prefixes

prefixes: string[] = new Array()

An array containing all the prefixes

readyAt

readyAt: Date | null

Readonly readyTimestamp

readyTimestamp: number | null

shard

shard: ShardClientUtil | null

Readonly tasks

tasks: TaskPool<string, Task> = new TaskPool(this)

The task pool that stores all tasks

token

token: string | null

Readonly uptime

uptime: number | null

user

user: ClientUser | null

users

users: UserManager

voice

voice: ClientVoiceManager | null

ws

ws: WebSocketManager

Accessors

pools

Methods

addListener

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

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

    Parameters

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

    Returns boolean

  • Type parameters

    • S: string | symbol

    Parameters

    Returns boolean

eventNames

  • eventNames(): Array<string | symbol>

  • Returns Array<string | symbol>

fetchApplication

  • fetchApplication(): Promise<ClientApplication>

  • Returns Promise<ClientApplication>

fetchGuildPreview

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

  • Parameters

    • guild: GuildResolvable

    Returns Promise<GuildPreview>

fetchInvite

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

  • Parameters

    • invite: InviteResolvable

    Returns Promise<Invite>

fetchVoiceRegions

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

  • Returns Promise<Collection<string, VoiceRegion>>

fetchWebhook

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

  • Parameters

    • id: Snowflake
    • Optional token: undefined | 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 | undefined): 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 | undefined

      Token of the bot account to log in with

    Returns Promise<string>

    Token

off

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

  • Type parameters

    Parameters

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

        • Parameters

          • Rest ...args: ClientEvents[K]

          Returns void

    Returns this

  • 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 this

on

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

  • Type parameters

    Parameters

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

        • Parameters

          • Rest ...args: ClientEvents[K]

          Returns void

    Returns this

  • 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 this

once

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

  • Type parameters

    Parameters

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

        • Parameters

          • Rest ...args: ClientEvents[K]

          Returns void

    Returns this

  • 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 this

prependListener

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependOnceListener

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

rawListeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

removeAllListeners

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

  • Type parameters

    Parameters

    • Optional event: K

    Returns this

  • Type parameters

    • S: string | symbol

    Parameters

    Returns this

removeListener

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

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): this

  • Parameters

    • n: number

    Returns this

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?: undefined | number): number

  • Parameters

    • Optional lifetime: undefined | number

    Returns number

toJSON

  • toJSON(): object

  • Returns object

Generated using TypeDoc