Class Finish

constructor

• new Finish(data): Finish

• Construct a new Finish instance.

  Parameters

  • data: {
        mapName: string;
        players: string[];
        rank: Rank;
        region: RankAvailableRegion;
        timeSeconds: number;
        timestamp: number;
    }

    • mapName: string

    • players: string[]

    • rank: Rank

    • region: RankAvailableRegion

    • timeSeconds: number

    • timestamp: number

  Returns Finish

mapName

players

rank

region

timeSeconds

timestamp

timeString

"03:23"
Copy

toMap

• toMap(rankSource?, force?): Promise<Map>

• Returns a new Map object from the mapName of this finish.

  Parameters

  • OptionalrankSource: null | RankAvailableRegion

    The region to pull ranks from in the toMap function from the returned value. Omit for global ranks.
  • force: boolean = false

    Wether to bypass the cache.

  Returns Promise<Map>

toString

• toString(): string

• Returns the names of the players and their finish time.

  Returns string

  Example

  "Sans3108 | 03:23"
  Copy