Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MoonlightClientOptions

example

{ ..., prefix: ['p.', 'p!'], displayErrors: false, readyMessage: (client) => Logged in as ${client.user.tag} }, fetchGuildPrefix: guild => getPrefix(guild.id)

Hierarchy

  • ClientOptions
    • MoonlightClientOptions

Index

Properties

Methods

Properties

Optional allowedMentions

allowedMentions: MessageMentionOptions

Optional disableMentions

disableMentions: "none" | "all" | "everyone"

Optional displayErrors

displayErrors: boolean

Whether or not to display error messages sent by the error event

Optional fetchAllMembers

fetchAllMembers: boolean

Optional http

http: HTTPOptions

Optional messageCacheLifetime

messageCacheLifetime: number

Optional messageCacheMaxSize

messageCacheMaxSize: number

Optional messageEditHistoryMaxSize

messageEditHistoryMaxSize: number

Optional messageSweepInterval

messageSweepInterval: number

Optional owners

owners: string[]

An array that contains the ID's of the owners

Optional partials

partials: PartialTypes[]

Optional prefix

prefix: string | string[]

The prefix or an array of prefixes the bot will use

Optional presence

presence: PresenceData

Optional restRequestTimeout

restRequestTimeout: number

Optional restSweepInterval

restSweepInterval: number

Optional restTimeOffset

restTimeOffset: number

Optional restWsBridgeTimeout

restWsBridgeTimeout: number

Optional retryLimit

retryLimit: number

Optional shardCount

shardCount: number

Optional shards

shards: number | number[] | "auto"

Optional useMentionPrefix

useMentionPrefix: boolean

Whether or not to use mention prefix

Optional useSweeper

useSweeper: boolean

Whether or not to use the built-in memory sweeper

Optional useUsernamePrefix

useUsernamePrefix: boolean

Whether or not to use username prefix - e.g. if the bot is called "Sensei" then the username prefix will be "Sensei, "

Optional ws

ws: WebSocketOptions

Methods

Optional fetchGuildPrefix

  • fetchGuildPrefix(guild: Guild): string | Promise<string>

  • The function the framework will use to fetch a prefix for a guild

    example

    fetchGuildPrefix: async (guild) => { const prefix = await fetchPrefix(guild.id); return prefix; }

    Parameters

    • guild: Guild

    Returns string | Promise<string>

Optional readyMessage

  • readyMessage(client: Client): string

  • Set the ready message to display when the bot is ready -> should return a string

    example

    readyMessage: (client) => Logged in and serving in ${client.guilds.size}!

    Parameters

    Returns string

Generated using TypeDoc