Documentation - v0.27.0
    Preparing search index...
    • Iterate over users who have joined the chat with the given invite link.

      Parameters

      • client: ITelegramClient
      • chatId: InputPeerLike

        Chat ID

      • Optionalparams: {
            limit?: number;
            link?: string | ChatInviteLink;
            offsetDate?: number | Date;
            offsetUser?: TypeInputUser;
            requested?: boolean;
            requestedSearch?: string;
        } & { chunkSize?: number; limit?: number }

        Additional params

        • Optionallimit?: number

          Maximum number of users to return

          100
          
        • Optionallink?: string | ChatInviteLink

          Invite link for which to get members

        • OptionaloffsetDate?: number | Date

          Offset request/join date used as an anchor for pagination.

        • OptionaloffsetUser?: TypeInputUser

          Offset user used as an anchor for pagination

        • Optionalrequested?: boolean

          Whether to get users who have requested to join the chat but weren't accepted yet

        • OptionalrequestedSearch?: string

          Search for a user in the pending join requests list (if passed, requested is assumed to be true)

          Doesn't work when link is set (Telegram limitation)

        • OptionalchunkSize?: number

          Chunk size which will be passed to messages.getChatInviteImporters. You shouldn't usually care about this.

          100.
          
        • Optionallimit?: number

          Maximum number of users to return

          Infinity, i.e. all users are fetched

      Returns AsyncIterableIterator<ChatInviteLinkMember>