Class Boost

constructor

• new Boost(raw: RawBoost, _peers: PeersIndex): Boost

  Parameters

  • raw: RawBoost
  • _peers: PeersIndex

  Returns Boost

Readonly_peers

Readonlyraw

count

• get count(): number

  Number of boosts this boost is actually representing

  Returns number

date

• get date(): Date

  Date when this boost was applied

  Returns Date

expireDate

• get expireDate(): Date

  Date when this boost will automatically expire.

  Note: User can still manually cancel the boost before that date

  Returns Date

giveawayMessageId

• get giveawayMessageId(): number | null

  ID of the message containing the giveaway where this user has won

  Returns number | null

id

• get id(): string

  Unique ID of this boost

  Returns string

origin

• get origin(): BoostOrigin

  Whether this boost was applied because the channel directly gifted a subscription to the user

  Returns BoostOrigin

stars

• get stars(): Long | null

  Amount of Telegram Stars that were awarded along with this boost

  Returns Long | null

usedGiftSlug

• get usedGiftSlug(): string | null

  The created Telegram Premium gift code, only set if origin is not user, AND it is either a gift code for the currently logged in user, or if it was already claimed

  Returns string | null

user

• get user(): User | null

  User who is boosting the channel.

  Only available for some origins

  Returns User | null