Class STClan

Class for clan information.

Hierarchy

Constructors

constructor

Properties

fetched games members points rank rate tag title website winstats

Methods

fetch isFetched set list

Constructors

constructor

  • new STClan(tag: string): STClan

Properties

Protected fetched

fetched: boolean = false

True if the class was fetched

Optional games

games?: STGame[]

The last 10 games that this clan participated in.

Optional members

members?: STClanMember[]

The members of this clan.

Optional points

points?: number

How many points the clan has. (wins + ties / 2)^2 / totalGames

Optional rank

rank?: number

The rank of this clan among other clans.

Optional rate

rate?: number

The win rate of this clan. (wins + ties / 2) / totalGames

tag

tag: string

The clan's tag.

Optional title

title?: string

The title of the clan.

Optional website

website?: string

A link to the clan's website.

Optional winstats

winstats?: STWinStats

The statistics on wins, losses, ties, and total games.

Methods

fetch

  • Fetches the data from the API, filling out the current object. This should be an asynchronous function.

    Returns

    This object after fetching

    Returns Promise<STClan>

isFetched

  • isFetched(): boolean

  • Returns

    True if this object is fetched

    Returns boolean

set

  • Sets properties based on the response sent from a request

    Returns

    This object after setting properties

    Parameters

    • data: any

      The response data from the API

    Returns STClan

Static list

  • Get list of all clans with some info sorted by rank

    Returns Promise<STClan[]>

Settings

Member Visibility

Theme

Generated using TypeDoc