Class RankEntity

constructor

• new RankEntity(client: RankedClient, data: Rank): RankEntity

  Instantiates a new RankEntity.

  Parameters

  • client: RankedClient

    The active SDK client instance.

  • data: Rank

    The raw rank data from the API.

  Returns RankEntity

color

iconUrl

id

lose

mvp

name

rankedSystemId

start

win

delete

• delete(): Promise<void>

  Deletes this rank permanently from the system.

  Returns Promise<void>

  A promise that resolves when the rank is successfully deleted.

update

• update(dto: UpdateRankDto): Promise<RankEntity>

  Updates this rank's settings.

  Parameters

  • dto: UpdateRankDto

    The fields to update.

  Returns Promise<RankEntity>

  A promise resolving to the updated RankEntity.

  Example

  await rank.update({ win: 25, lose: 15 });
  Copy

uploadIcon

• uploadIcon(fileBuffer: Buffer, filename: string): Promise<string>

  Uploads or updates the icon image for this rank.

  Parameters

  • fileBuffer: Buffer

    The binary buffer of the image file.

  • filename: string

    The name of the file (e.g., 'gold.png').

  Returns Promise<string>

  A promise resolving to the new icon URL.

  Example

  const fs = require('fs');
  const buffer = fs.readFileSync('./icons/diamond.png');
  const newUrl = await rank.uploadIcon(buffer, 'diamond.png');
  Copy