Class StarGift

constructor

• new StarGift(raw: RawStarGift, _peers: PeersIndex): StarGift

  Parameters

  • raw: RawStarGift
  • _peers: PeersIndex

  Returns StarGift

Readonly_peers

ReadonlyisUnique

Readonlyraw

action

• get action(): { giftsPerRound: number; slug: string } | null

  If this gift is currently sold through an auction, info about that auction. null otherwise

  Returns { giftsPerRound: number; slug: string } | null

availability

• get availability(): { remains: number; resale: Long; total: number } | null

  For limited availability gifts, the number of remaining and total gifts available

  Returns { remains: number; resale: Long; total: number } | null

  • { remains: number; resale: Long; total: number }

    • remains: number

    • resale: Long

      Number of gifts available on the secondary market

    • total: number

  • null

convertStars

• get convertStars(): Long

  Amount of stars the gift can be converted to by the recipient

  Returns Long

hasPeerColor

• get hasPeerColor(): boolean

  Whether this gift includes a peer color that can be applied to user's profile

  Returns boolean

id

• get id(): Long

  ID of the gift

  Returns Long

isLimited

• get isLimited(): boolean

  Whether this gift has limited availability

  Returns boolean

isPremiumOnly

• get isPremiumOnly(): boolean

  Whether this gift is available only to premium users

  Returns boolean

isSoldOut

• get isSoldOut(): boolean

  Whether this gift sold out and cannot be bought anymore

  Returns boolean

perUserAvailability

• get perUserAvailability(): { remains: number; total: number } | null

  For gifts with limited availability per user, the number of remaining and total gifts available

  Returns { remains: number; total: number } | null

purchaseStars

• get purchaseStars(): Long

  Amount of stars the gift was purchased for

  Returns Long

releasedBy

• get releasedBy(): Peer | null

  User/channel who released this collection

  Returns Peer | null

resaleFloorPrice

• get resaleFloorPrice(): Long | null

  Floor price for the gift on the secondary market

  Returns Long | null

soldOutInfo

• get soldOutInfo(): { firstSale: Date; lastSale: Date } | null

  Additional information for sold-out gifts

  Returns { firstSale: Date; lastSale: Date } | null

  • { firstSale: Date; lastSale: Date }

    • firstSale: Date

      Date when the first gift was bought

    • lastSale: Date

      Date when the last gift was bought

  • null

sticker

• get sticker(): Sticker

  Sticker associated with the gift

  Returns Sticker

title

• get title(): string | null

  Title of the gift

  Returns string | null

upgradeStars

• get upgradeStars(): Long | null

  Amount of stars the gift can be upgraded for

  Returns Long | null