Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Client

Hierarchy

  • internal
    • Client

Index

Classes

Constructors

Properties

Methods

Constructors

constructor

  • new Client(cookie: string): Client

Properties

badges

badges: Collection<Base["id"], Badge>

Private Optional cookie

cookie: undefined | string

Optional debug

debug: undefined | false | true

groups

groups: Collection<Base["id"], Group>

Private httpInterval

httpInterval: number

Private Optional httpIntervalId

httpIntervalId: NodeJS.Timeout

Private httpQueue

httpQueue: HttpRequest[]

Private httpTimeout

httpTimeout: number

roles

roles: Collection<Base["id"], Role>

Private Optional token

token: undefined | string

users

users: Collection<Base["id"], User>

Methods

addListener

  • addListener(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (args: any[]): void

        • Parameters

          • Rest args: any[]

          Returns void

    Returns this

emit

  • emit(event: string | symbol, args: any[]): boolean

  • Parameters

    • event: string | symbol
    • Rest args: any[]

    Returns boolean

eventNames

  • eventNames(): Array<string | symbol>

  • Returns Array<string | symbol>

getGroup

  • getGroup<G>(id: number, cachedGroup: G): Promise<G>
  • getGroup(id: number): Promise<Group>

getMaxListeners

  • getMaxListeners(): number

  • Returns number

getUser

  • getUser(id: number): Promise<User>

getUserByName

  • getUserByName(name: string): Promise<User>

Private handleHttpQueue

  • handleHttpQueue(): Promise<void>

http

listenerCount

  • listenerCount(type: string | symbol): number

  • Parameters

    • type: string | symbol

    Returns number

listeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

login

  • login(cookie: string): Promise<void>

off

  • off(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (args: any[]): void

        • Parameters

          • Rest args: any[]

          Returns void

    Returns this

on

  • on(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (args: any[]): void

        • Parameters

          • Rest args: any[]

          Returns void

    Returns this

once

  • once(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (args: any[]): void

        • Parameters

          • Rest args: any[]

          Returns void

    Returns this

prependListener

  • prependListener(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (args: any[]): void

        • Parameters

          • Rest args: any[]

          Returns void

    Returns this

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (args: any[]): void

        • Parameters

          • Rest args: any[]

          Returns void

    Returns this

rawListeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

Private rejectCatcher

  • rejectCatcher(catchConfig: CatchConfig, errResponse: AxiosResponse): void

removeAllListeners

  • removeAllListeners(event: string | symbol): this

  • Parameters

    • Optional event: string | symbol

    Returns this

removeListener

  • removeListener(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (args: any[]): void

        • Parameters

          • Rest args: any[]

          Returns void

    Returns this

setMaxListeners

  • setMaxListeners(n: number): this

  • Parameters

    • n: number

    Returns this

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