Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GuildManager

Hierarchy

  • EventEmitter
    • GuildManager

Index

Constructors

Events

Properties

Accessors

Methods

Constructors

constructor

Events

emit

emit: <U>(event: U, ...args: Parameters<EventTypes[U]>) => boolean

Type declaration

    • <U>(event: U, ...args: Parameters<EventTypes[U]>): boolean

    • Type parameters

      Parameters

      • event: U
      • Rest ...args: Parameters<EventTypes[U]>

      Returns boolean

on

on: <U>(event: U, listener: EventTypes[U]) => GuildManager

Type declaration

once

once: <U>(event: U, listener: EventTypes[U]) => GuildManager

Type declaration

Properties

Private _ready

_ready: boolean = false

cache

cache: Collection<string, Guild>

client

client: default

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

ready

  • get ready(): boolean

Methods

addListener

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns GuildManager

awaitReady

  • awaitReady(): Promise<void>

create

  • create(guildConfig: Omit<GuildConfig, "_id">, cache?: boolean): Promise<Guild>

  • Create a new guild.

    Parameters

    • guildConfig: Omit<GuildConfig, "_id">

      Guild metadata.

    • cache: boolean = true

      Caches parsed object from response. Default true.

    Returns Promise<Guild>

    A promise that resolves to a Guild object.

eventNames

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

  • Returns (string | symbol)[]

fetch

  • fetch(id?: string, force?: boolean, cache?: boolean): Promise<Guild | Guild[]>

  • Fetch data from cache or send a request the API endpoint if not cached.

    Parameters

    • id: string = ''
    • force: boolean = false

      Force fetch from the API endpoint. Default false.

    • cache: boolean = true

      Caches parsed object from response. Default true.

    Returns Promise<Guild | Guild[]>

    A promise that resolves to a Guild object or an Array of Guild objects if no ID is provided.

getMaxListeners

  • getMaxListeners(): number

  • Returns number

Private hydrate

  • hydrate(): Promise<void>

listenerCount

  • listenerCount(event: string | symbol): number

  • Parameters

    • event: string | symbol

    Returns number

listeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

off

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns GuildManager

prependListener

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns GuildManager

prependOnceListener

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns GuildManager

rawListeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

removeAllListeners

  • Parameters

    • Optional event: string | symbol

    Returns GuildManager

removeListener

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns GuildManager

resolve

resolveID

setMaxListeners

  • Parameters

    • n: number

    Returns GuildManager

Static getEventListener

  • getEventListener(emitter: DOMEventTarget | EventEmitter, name: string | symbol): Function[]

  • Returns a list listener for a specific emitter event name.

    Parameters

    • emitter: DOMEventTarget | EventEmitter
    • name: string | symbol

    Returns Function[]

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, options?: StaticEventEmitterOptions): AsyncIterableIterator<any>

  • Parameters

    • emitter: EventEmitter
    • event: string
    • Optional options: StaticEventEmitterOptions

    Returns AsyncIterableIterator<any>

Static once

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

  • Parameters

    • emitter: NodeEventTarget
    • event: string | symbol
    • Optional options: StaticEventEmitterOptions

    Returns Promise<any[]>

  • Parameters

    • emitter: DOMEventTarget
    • event: string
    • Optional options: StaticEventEmitterOptions

    Returns Promise<any[]>

Generated using TypeDoc