LeaderboardCard

Represents a Quiz Leaderboard Card. A class for generating a leaderboard card for a quiz or game.

@returns

• The generated image buffer.

Index

Constructors

• constructor

Methods

• build
• setBackground
• setColors
• setOpacity
• setScoreMessage
• setUsersData
• setabbreviateNumber

Constructors

constructor

• new LeaderboardCard(options: LeaderboardOptions): LeaderboardCard

• Parameters

  Name	Type	Default	Description
  options	LeaderboardOptions

  Returns LeaderboardCard

Methods

build

• build(): Promise<Buffer>

• Returns Promise<Buffer>

setBackground

• setBackground(type: string, value: string): this

• .setBackground

  @example

  setBackground("image","https://someone-image.png")

  @example

  setBackground("color","#000")

  ---

  Parameters

  Name	Type	Default	Description
  type	string		"image" or "color"
  value	string		"url" or "hexcolor"

  Returns this

setColors

• setColors(colors: colorsType): this

• .setColors

  @example

  setColors({ box: '#212121', username: '#ffffff', score: '#ffffff', firstRank: '#f7c716', secondRank: '#9e9e9e', thirdRank: '#94610f' })

  ---

  Parameters

  Name	Type	Default	Description
  colors	colorsType		{box: "hexcolor", username: "hexcolor", score: "hexcolor", firstRank: "hexcolor", secondRank: "hexcolor", thirdRank: "hexcolor"}

  Returns this

setOpacity

• setOpacity(opacity?: number): this

• .setOpacity

  @example

  setOpacity(0.6)

  ---

  Parameters

  Name	Type	Default	Description
  opacity	number	= 0	must be between 0 and 1

  Returns this

setScoreMessage

• setScoreMessage(message: string): this

• .setScoreMessage

  @example

  setScoreMessage("Message")

  ---

  Parameters

  Name	Type	Default	Description
  message	string		Set Custom Score Message

  Returns this

setUsersData

• setUsersData(usersData: userData[]): this

• .setUsersData

  @example

  setUsersData([{top:1,avatar:"https://someone-image.png",tag:"fivesobes",score:5, games:8}])

  ---

  Parameters

  Name	Type	Default	Description
  usersData	userData[]		[{ top: int, avatar: "string", tag: "string", score: int}, games: int]

  Returns this

setabbreviateNumber

• setabbreviateNumber(bool: boolean): this

• .setabbreviateNumber

  @example

  setabbreviateNumber(true)

  ---

  Parameters

  Name	Type	Default	Description
  bool	boolean		must be "true" or "false"

  Returns this