Options
All
  • Public
  • Public/Protected
  • All
Menu

Class default

Main client class.

example
const options = {
  session: 'copySessionTokenFromCookies',
  fetchSubmissionsOnStart: true, // Fetch and cache all submissions when creating new client. Default: false
}

const client = new Client(options);

Hierarchy

  • EventEmitter
    • default

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Private _ready

_ready: boolean = false

admin

admin: AdminManager

axios

axios: AxiosInstance

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

endpoints

endpoints: Endpoints

guilds

guilds: GuildManager

on

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

Type declaration

once

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

Type declaration

options

options: ClientOptions

projects

projects: ProjectManager

submissions

submissions: SubmissionManager

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns default

eventNames

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

  • Returns (string | symbol)[]

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

off

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns default

prependListener

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns default

prependOnceListener

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns default

rawListeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

removeAllListeners

  • removeAllListeners(event?: string | symbol): default

  • Parameters

    • Optional event: string | symbol

    Returns default

removeListener

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns default

setEndpoint

setMaxListeners

  • setMaxListeners(n: number): default

  • Parameters

    • n: number

    Returns default

Private waitAllReady

  • waitAllReady(): Promise<void>

  • Initial code to make sure everything is ready.

    fires

    Client#ready

    Returns Promise<void>

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