Options
All
  • Public
  • Public/Protected
  • All
Menu

Class League

Hierarchy

  • Transformable
    • League

Index

Constructors

Properties

Methods

Constructors

constructor

  • Returns League

Properties

delveEvent

delveEvent: boolean

Optional description

description: string

endAt

endAt: null | Date

id

id: string

Optional ladder

ladder: Ladder

realm

realm: Realm

Optional registerAt

registerAt: Date

Optional rules

rules: Rule[]

Optional scoreEvent

scoreEvent: boolean

startAt

startAt: Date

Optional timedEvent

timedEvent: boolean

url

url: string

Methods

getLadder

  • remarks

    If store is set to true the ladder property will be overwritten.

    throws

    APIError

    Parameters

    • Optional options: Options
    • store: boolean = true

      If set to true, the ladder will be saved in the ladder property

    Returns Promise<Ladder>

    The ladder for this league

toPlain

  • toPlain(): unknown

  • Converts this class back into a plain javascript object.

    remarks

    Property keys which have been renamed during the initial transformation to a class object will be reverted to the original keys. For example, the cachedSince property in the Ladder class will be reverted to the original API property, cached_since.

    Returns unknown

Generated using TypeDoc