Class Release

constructor

• new Release(
      data: {
          difficulty: number;
          height: number;
          mapper: string;
          name: string;
          points: number;
          releaseTimestamp: number;
          thumbnail: string;
          tiles: string[];
          type: string;
          web_preview: string;
          website: string;
          width: number;
      },
  ): Release

  Construct a new Release instance.

  Parameters

  • data: {
        difficulty: number;
        height: number;
        mapper: string;
        name: string;
        points: number;
        releaseTimestamp: number;
        thumbnail: string;
        tiles: string[];
        type: string;
        web_preview: string;
        website: string;
        width: number;
    }

  Returns Release

difficulty

height

mappers

name

points

releasedTimestamp

thumbnailUrl

tiles

type

url

webPreviewUrl

width

getLatestFinishes

• getLatestFinishes(filters?: LatestFinishesFilters): Promise<Finish[]>

  Get latest finishes, filtered for this release.

  Parameters

  • Optionalfilters: LatestFinishesFilters

    Filtering options for latest finishes.

  Returns Promise<Finish[]>

toMap

• toMap(rankSource?: ServerRegion | null, force?: boolean): Promise<Map>

  Returns a new Map object from the name of this release.

  Parameters

  • OptionalrankSource: ServerRegion | null

    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 name and url of this release in markdown format.

  Returns string

StaticgetLatestFinishes

• getLatestFinishes(
      mapName: string,
      filters?: LatestFinishesFilters,
  ): Promise<Finish[]>

  Get latest finishes, filtered for a specific release.

  Parameters

  • mapName: string

    The name of the map.

  • Optionalfilters: LatestFinishesFilters

    Filtering options for latest finishes.

  Returns Promise<Finish[]>