Function iterStarGifts

  • iterStarGifts(
        client: ITelegramClient,
        peerId: InputPeerLike,
        params?: { limit?: number; offset?: string } & {
            chunkSize?: number;
            limit?: number;
        },
    ): AsyncIterableIterator<UserStarGift>

  • Iterate over gifts sent to a given user.

    Wrapper over getStarGifts

    Parameters

    • client: ITelegramClient
    • peerId: InputPeerLike

      Peer ID

    • Optionalparams: { limit?: number; offset?: string } & { chunkSize?: number; limit?: number }

      Additional parameters

      • Optionallimit?: number

        Maximum number of gifts to fetch.

        Default

        100
      • Optionaloffset?: string

        Offset for pagination.

      • OptionalchunkSize?: number

        Number of gifts to fetch per request Usually you don't need to change this

        Default

        100
      • Optionallimit?: number

        Total number of gifts to fetch

        Default

        Infinity, i.e. fetch all gifts

    Returns AsyncIterableIterator<UserStarGift>

Settings

Member Visibility