Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Profile

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Optional challenges

challenges: Challenges

Optional guild

guild: Guild

name

name: string

realm

realm: Realm

Optional twitch

twitch: Stream

uuid

uuid: null | string

Methods

getCharacters

  • remarks

    Trying to get characters when the profile or character tab is private will result in an error.

    throws

    APIError

    Parameters

    Returns Promise<Character[]>

    A list of characters from this account

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