@mtcute/core 0.16.7 → 0.16.9

package/highlevel/methods/invite-links/iter-invite-links.d.ts

@@ -0,0 +1,27 @@
+import { ITelegramClient } from '../../client.types.js';
+import { ChatInviteLink, InputPeerLike } from '../../types/index.js';
+import { getInviteLinks } from './get-invite-links.js';
+/**
+ * Iterate over invite links created by some administrator in the chat.
+ *
+ * As an administrator you can only get your own links
+ * (i.e. `adminId = "self"`), as a creator you can get
+ * any other admin's links.
+ *
+ * @param chatId  Chat ID
+ * @param adminId  Admin who created the links
+ * @param params
+ */
+export declare function iterInviteLinks(client: ITelegramClient, chatId: InputPeerLike, params?: Parameters<typeof getInviteLinks>[2] & {
+    /**
+     * Limit the number of invite links to be fetched.
+     * By default, all links are fetched.
+     */
+    limit?: number;
+    /**
+     * Size of chunks which are fetched. Usually not needed.
+     *
+     * @default  `100`
+     */
+    chunkSize?: number;
+}): AsyncIterableIterator<ChatInviteLink>;

package/highlevel/methods/invite-links/revoke-invite-link.d.ts

@@ -0,0 +1,13 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike, ChatInviteLink } from '../../types/index.js';
+/**
+ * Revoke an invite link.
+ *
+ * If `link` is a primary invite link, a new invite link will be
+ * generated automatically by Telegram
+ *
+ * @param chatId  Chat ID
+ * @param link  Invite link to revoke
+ * @returns  If `link` is a primary invite, newly generated invite link, otherwise the revoked link
+ */
+export declare function revokeInviteLink(client: ITelegramClient, chatId: InputPeerLike, link: string | ChatInviteLink): Promise<ChatInviteLink>;

package/highlevel/methods/messages/_business-connection.d.ts

@@ -0,0 +1,8 @@
+import { tl } from '@mtcute/tl';
+import { RpcCallOptions } from '../../../network/network-manager.js';
+import { MustEqual } from '../../../types/utils.js';
+import { ITelegramClient } from '../../client.types.js';
+/**
+ * @internal
+ */
+export declare function _maybeInvokeWithBusinessConnection<T extends tl.RpcMethod>(client: ITelegramClient, businessConnectionId: string | undefined, request: MustEqual<T, tl.RpcMethod>, params?: RpcCallOptions): Promise<tl.RpcCallReturn[T['_']]>;

package/highlevel/methods/messages/close-poll.d.ts

@@ -0,0 +1,15 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputMessageId, Poll } from '../../types/index.js';
+/**
+ * Close a poll sent by you.
+ *
+ * Once closed, poll can't be re-opened, and nobody
+ * will be able to vote in it
+ */
+export declare function closePoll(client: ITelegramClient, params: InputMessageId & {
+    /**
+     * Whether to dispatch the edit message event
+     * to the client's update handler.
+     */
+    shouldDispatch?: true;
+}): Promise<Poll>;

package/highlevel/methods/messages/delete-messages.d.ts

@@ -0,0 +1,29 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike, Message } from '../../types/index.js';
+export interface DeleteMessagesParams {
+    /**
+     * Whether to "revoke" (i.e. delete for both sides).
+     * Only used for chats and private chats.
+     *
+     * @default  true
+     */
+    revoke?: boolean;
+    /**
+     * Whether to dispatch updates that will be generated by this call.
+     * Doesn't follow `disableNoDispatch`
+     */
+    shouldDispatch?: true;
+}
+/**
+ * Delete messages by their IDs
+ *
+ * @param chatId  Chat's marked ID, its username, phone or `"me"` or `"self"`.
+ * @param ids  Message(s) ID(s) to delete.
+ */
+export declare function deleteMessagesById(client: ITelegramClient, chatId: InputPeerLike, ids: number[], params?: DeleteMessagesParams): Promise<void>;
+/**
+ * Delete one or more {@link Message}
+ *
+ * @param messages  Message(s) to delete
+ */
+export declare function deleteMessages(client: ITelegramClient, messages: Message[], params?: DeleteMessagesParams): Promise<void>;

package/highlevel/methods/messages/delete-scheduled-messages.d.ts

@@ -0,0 +1,9 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike } from '../../types/index.js';
+/**
+ * Delete scheduled messages by their IDs.
+ *
+ * @param chatId  Chat's marked ID, its username, phone or `"me"` or `"self"`.
+ * @param ids  Message(s) ID(s) to delete.
+ */
+export declare function deleteScheduledMessages(client: ITelegramClient, chatId: InputPeerLike, ids: number[]): Promise<void>;

package/highlevel/methods/messages/edit-inline-message.d.ts

@@ -0,0 +1,51 @@
+import { tl } from '@mtcute/tl';
+import { ITelegramClient } from '../../client.types.js';
+import { InputMediaLike, InputText, ReplyMarkup } from '../../types/index.js';
+/**
+ * Edit sent inline message text, media and reply markup.
+ *
+ * @param messageId
+ *     Inline message ID, either as a TL object, or as a
+ *     TDLib and Bot API compatible string
+ * @param params
+ */
+export declare function editInlineMessage(client: ITelegramClient, params: {
+    /**
+     * Inline message ID, either as a TL object, or as a
+     * TDLib and Bot API compatible string
+     */
+    messageId: tl.TypeInputBotInlineMessageID | string;
+    /**
+     * New message text
+     *
+     * When `media` is passed, `media.caption` is used instead
+     */
+    text?: InputText;
+    /**
+     * New message media
+     */
+    media?: InputMediaLike;
+    /**
+     * Whether to disable links preview in this message
+     */
+    disableWebPreview?: boolean;
+    /**
+     * Whether to invert media position.
+     *
+     * Currently only supported for web previews and makes the
+     * client render the preview above the caption and not below.
+     */
+    invertMedia?: boolean;
+    /**
+     * For bots: new reply markup.
+     * If omitted, existing markup will be removed.
+     */
+    replyMarkup?: ReplyMarkup;
+    /**
+     * For media, upload progress callback.
+     *
+     * @param uploaded  Number of bytes uploaded
+     * @param total  Total file size in bytes
+     */
+    progressCallback?: (uploaded: number, total: number) => void;
+}): Promise<void>;

package/highlevel/methods/messages/edit-message.d.ts

@@ -0,0 +1,55 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputMediaLike, InputMessageId, InputText, Message, ReplyMarkup } from '../../types/index.js';
+/**
+ * Edit message text, media, reply markup and schedule date.
+ *
+ * @param chatId  ID of the chat, its username, phone or `"me"` or `"self"`
+ * @param message  Message or its ID
+ * @param params
+ */
+export declare function editMessage(client: ITelegramClient, params: InputMessageId & {
+    /**
+     * New message text
+     *
+     * When `media` is passed, `media.caption` is used instead
+     */
+    text?: InputText;
+    /**
+     * New message media
+     */
+    media?: InputMediaLike;
+    /**
+     * Whether to disable links preview in this message
+     */
+    disableWebPreview?: boolean;
+    /**
+     * For bots: new reply markup.
+     * If omitted, existing markup will be removed.
+     */
+    replyMarkup?: ReplyMarkup;
+    /**
+     * To re-schedule a message: new schedule date.
+     * When passing a number, a UNIX time in ms is expected.
+     */
+    scheduleDate?: Date | number;
+    /**
+     * For media, upload progress callback.
+     *
+     * @param uploaded  Number of bytes uploaded
+     * @param total  Total file size in bytes
+     */
+    progressCallback?: (uploaded: number, total: number) => void;
+    /**
+     * Whether to dispatch the edit message event
+     * to the client's update handler.
+     */
+    shouldDispatch?: true;
+    /**
+     * Whether to invert media position.
+     *
+     * Currently only supported for web previews and makes the
+     * client render the preview above the caption and not below.
+     */
+    invertMedia?: boolean;
+    businessConnectionId?: string;
+}): Promise<Message>;

package/highlevel/methods/messages/find-in-update.d.ts

@@ -0,0 +1,13 @@
+import { tl } from '@mtcute/tl';
+import { ITelegramClient } from '../../client.types.js';
+import { Message } from '../../types/messages/index.js';
+/**
+ * @internal
+ * @noemit
+ */
+export declare function _findMessageInUpdate(client: ITelegramClient, res: tl.TypeUpdates, isEdit?: boolean, noDispatch?: boolean, allowNull?: false, randomId?: tl.Long): Message;
+/**
+ * @internal
+ * @noemit
+ */
+export declare function _findMessageInUpdate(client: ITelegramClient, res: tl.TypeUpdates, isEdit?: boolean, noDispatch?: boolean, allowNull?: true, randomId?: tl.Long): Message | null;

package/highlevel/methods/messages/forward-messages.d.ts

@@ -0,0 +1,78 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike, Message } from '../../types/index.js';
+export interface ForwardMessageOptions {
+    /** Destination chat ID, username, phone, `"me"` or `"self"` */
+    toChatId: InputPeerLike;
+    /**
+     * Whether to forward silently (also applies to caption message).
+     */
+    silent?: boolean;
+    /**
+     * If set, the forwarding will be scheduled to this date
+     * (also applies to caption message).
+     * When passing a number, a UNIX time in ms is expected.
+     *
+     * You can also pass `0x7FFFFFFE`, this will send the message
+     * once the peer is online
+     */
+    schedule?: Date | number;
+    /**
+     * Whether to clear draft after sending this message (only used for caption)
+     *
+     * @default  `false`
+     */
+    clearDraft?: boolean;
+    /**
+     * Whether to forward without author
+     */
+    noAuthor?: boolean;
+    /**
+     * Whether to forward without caption (implies {@link noAuthor})
+     */
+    noCaption?: boolean;
+    /**
+     * Whether to disallow further forwards of this message.
+     *
+     * Only for bots, works even if the target chat does not
+     * have content protection.
+     */
+    forbidForwards?: boolean;
+    /**
+     * Peer to use when sending the message.
+     */
+    sendAs?: InputPeerLike;
+    /**
+     * If passed, instead of sending the message, it will be saved into the
+     * given quick reply shortcut (either its ID or its shortcut string).
+     */
+    quickReply?: number | string;
+    /**
+     * Whether to dispatch the forwarded messages
+     * to the client's update handler.
+     */
+    shouldDispatch?: true;
+}
+/**
+ * Forward one or more messages by their IDs.
+ * You can forward no more than 100 messages at once.
+ *
+ * @param toChatId  Destination chat ID, username, phone, `"me"` or `"self"`
+ * @param fromChatId  Source chat ID, username, phone, `"me"` or `"self"`
+ * @param messages  Message IDs
+ * @param params  Additional sending parameters
+ * @returns  Newly sent, forwarded messages in the destination chat.
+ */
+export declare function forwardMessagesById(client: ITelegramClient, params: ForwardMessageOptions & {
+    /** Source chat ID, username, phone, `"me"` or `"self"` */
+    fromChatId: InputPeerLike;
+    /** Message IDs to forward */
+    messages: number[];
+}): Promise<Message[]>;
+/**
+ * Forward one or more {@link Message}s to another chat.
+ *
+ * > **Note**: all messages must be from the same chat.
+ */
+export declare function forwardMessages(client: ITelegramClient, params: ForwardMessageOptions & {
+    messages: Message[];
+}): Promise<Message[]>;

package/highlevel/methods/messages/get-all-scheduled-messages.d.ts

@@ -0,0 +1,8 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike, Message } from '../../types/index.js';
+/**
+ * Get all scheduled messages in chat
+ *
+ * @param chatId  Chat's marked ID, its username, phone or `"me"` or `"self"`
+ */
+export declare function getAllScheduledMessages(client: ITelegramClient, chatId: InputPeerLike): Promise<Message[]>;

package/highlevel/methods/messages/get-available-effects.d.ts

@@ -0,0 +1,6 @@
+import { ITelegramClient } from '../../client.types.js';
+import { MessageEffect } from '../../types/index.js';
+/**
+ * Get a list of available message effects
+ */
+export declare function getAvailableMessageEffects(client: ITelegramClient): Promise<MessageEffect[]>;

package/highlevel/methods/messages/get-callback-query-message.d.ts

@@ -0,0 +1,14 @@
+import { tl } from '@mtcute/tl';
+import { ITelegramClient } from '../../client.types.js';
+import { Message } from '../../types/messages/message.js';
+import { InputPeerLike } from '../../types/peers/index.js';
+import { CallbackQuery } from '../../types/updates/callback-query.js';
+/**
+ * Get the message containing the button being clicked
+ * in the given callback query.
+ */
+export declare function getCallbackQueryMessage(client: ITelegramClient, id: CallbackQuery | tl.RawUpdateBotCallbackQuery | {
+    messageId: number;
+    queryId: tl.Long;
+    peer: InputPeerLike;
+}): Promise<Message | null>;

package/highlevel/methods/messages/get-discussion-message.d.ts

@@ -0,0 +1,21 @@
+import { tl } from '@mtcute/tl';
+import { ITelegramClient } from '../../client.types.js';
+import { InputMessageId, Message } from '../../types/messages/index.js';
+import { InputPeerLike } from '../../types/peers/index.js';
+/** @internal */
+export declare function _getDiscussionMessage(client: ITelegramClient, peer: InputPeerLike, message: number): Promise<[tl.TypeInputPeer, number]>;
+/**
+ * Get discussion message for some channel post.
+ *
+ * Returns `null` if the post does not have a discussion
+ * message.
+ *
+ * This method might throw `FLOOD_WAIT_X` error in case
+ * the discussion message was not *yet* created. Error
+ * is usually handled by the client, but if you disabled that,
+ * you'll need to handle it manually.
+ *
+ * @param peer  Channel where the post was found
+ * @param message  ID of the channel post
+ */
+export declare function getDiscussionMessage(client: ITelegramClient, params: InputMessageId): Promise<Message | null>;

package/highlevel/methods/messages/get-fact-check.d.ts

@@ -0,0 +1,11 @@
+import { MaybeArray } from '../../../types/utils.js';
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike } from '../../types/index.js';
+import { FactCheck } from '../../types/messages/fact-check.js';
+/**
+ * Get fact check information for one or more messages in a chat
+ *
+ * @param chatId  Chat where the messages are located
+ * @param msgIds  One or more message IDs
+ */
+export declare function getFactCheck(client: ITelegramClient, chatId: InputPeerLike, msgIds: MaybeArray<number>): Promise<(FactCheck | null)[]>;

package/highlevel/methods/messages/get-history.d.ts

@@ -0,0 +1,61 @@
+import { ITelegramClient } from '../../client.types.js';
+import { ArrayPaginated, InputPeerLike, Message } from '../../types/index.js';
+export interface GetHistoryOffset {
+    id: number;
+    date: number;
+}
+/**
+ * Get chat history.
+ *
+ * @param chatId  Chat's marked ID, its username, phone or `"me"` or `"self"`.
+ * @param params  Additional fetch parameters
+ */
+export declare function getHistory(client: ITelegramClient, chatId: InputPeerLike, params?: {
+    /**
+     * Limits the number of messages to be retrieved.
+     *
+     * @default  100
+     */
+    limit?: number;
+    /**
+     * Offset for pagination
+     */
+    offset?: GetHistoryOffset;
+    /**
+     * Additional offset from {@link offset}, in resulting messages.
+     *
+     * This can be used for advanced use cases, like:
+     * - Loading 20 messages newer than message with ID `MSGID`:
+     *   `offset = MSGID, addOffset = -20, limit = 20`
+     * - Loading 20 messages around message with ID `MSGID`:
+     *   `offset = MSGID, addOffset = -10, limit = 20`
+     *
+     * @default  `0` (disabled)
+     */
+    addOffset?: number;
+    /**
+     * Minimum message ID to return
+     *
+     * @default  `0` (disabled).
+     */
+    minId?: number;
+    /**
+     * Maximum message ID to return.
+     *
+     * Unless {@link addOffset} is used, this will work the same as {@link offset}.
+     *
+     * @default  `0` (disabled).
+     */
+    maxId?: number;
+    /**
+     * Whether to retrieve messages in reversed order (from older to recent),
+     * starting from {@link offset} (inclusive).
+     *
+     * > **Note**: Using `reverse=true` requires you to pass offset from which to start
+     * > fetching the messages "downwards". If you call `getHistory` with `reverse=true`
+     * > and without any offset, it will return an empty array.
+     *
+     * @default false
+     */
+    reverse?: boolean;
+}): Promise<ArrayPaginated<Message, GetHistoryOffset>>;

package/highlevel/methods/messages/get-message-by-link.d.ts

@@ -0,0 +1,6 @@
+import { ITelegramClient } from '../../client.types.js';
+import { Message } from '../../types/messages/index.js';
+/**
+ * Given a message link (e.g. `t.me/durov/1`), fetch the relevant message.
+ */
+export declare function getMessageByLink(client: ITelegramClient, link: string): Promise<Message | null>;

package/highlevel/methods/messages/get-message-group.d.ts

@@ -0,0 +1,9 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputMessageId, Message } from '../../types/index.js';
+/**
+ * Get all messages inside of a message group
+ *
+ * @param chatId  Chat ID
+ * @param message  ID of one of the messages in the group
+ */
+export declare function getMessageGroup(client: ITelegramClient, params: InputMessageId): Promise<Message[]>;

package/highlevel/methods/messages/get-message-reactions.d.ts

@@ -0,0 +1,28 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike, Message, MessageReactions } from '../../types/index.js';
+/**
+ * Get reactions to messages by their IDs.
+ *
+ * > Apps should short-poll reactions for visible messages
+ * > (that weren't sent by the user) once every 15-30 seconds,
+ * > but only if `message.reactions` is set
+ *
+ * @param chatId  ID of the chat with messages
+ * @param messages  Message IDs
+ * @returns  Reactions to corresponding messages, or `null` if there are none
+ */
+export declare function getMessageReactionsById(client: ITelegramClient, chatId: InputPeerLike, messages: number[]): Promise<(MessageReactions | null)[]>;
+/**
+ * Get reactions to {@link Message}s.
+ *
+ * > **Note**: messages must all be from the same chat.
+ *
+ * > Apps should short-poll reactions for visible messages
+ * > (that weren't sent by the user) once every 15-30 seconds,
+ * > but only if `message.reactions` is set
+ *
+ * @param chatId  ID of the chat with messages
+ * @param messages  Message IDs
+ * @returns  Reactions to corresponding messages, or `null` if there are none
+ */
+export declare function getMessageReactions(client: ITelegramClient, messages: Message[]): Promise<(MessageReactions | null)[]>;

package/highlevel/methods/messages/get-messages-unsafe.d.ts

@@ -0,0 +1,19 @@
+import { MaybeArray } from '../../../types/utils.js';
+import { ITelegramClient } from '../../client.types.js';
+import { Message } from '../../types/index.js';
+/**
+ * Get messages from PM or legacy group by their IDs.
+ * For channels, use {@link getMessages}.
+ *
+ * Unlike {@link getMessages}, this method does not
+ * check if the message belongs to some chat.
+ *
+ * Fot messages that were not found, `null` will be
+ * returned at that position.
+ *
+ * @param messageIds  Messages IDs
+ * @param [fromReply]
+ *     Whether the reply to a given message should be fetched
+ *     (i.e. `getMessages(msg.chat.id, msg.id, true).id === msg.replyToMessageId`)
+ */
+export declare function getMessagesUnsafe(client: ITelegramClient, messageIds: MaybeArray<number>, fromReply?: boolean): Promise<(Message | null)[]>;

package/highlevel/methods/messages/get-messages.d.ts

@@ -0,0 +1,17 @@
+import { MaybeArray } from '../../../types/utils.js';
+import { ITelegramClient } from '../../client.types.js';
+import { Message } from '../../types/messages/index.js';
+import { InputPeerLike } from '../../types/peers/index.js';
+/**
+ * Get messages in chat by their IDs
+ *
+ * Fot messages that were not found, `null` will be
+ * returned at that position.
+ *
+ * @param chatId  Chat's marked ID, its username, phone or `"me"` or `"self"`
+ * @param messageIds  Messages IDs
+ * @param [fromReply]
+ *     Whether the reply to a given message should be fetched
+ *     (i.e. `getMessages(msg.chat.id, msg.id, true).id === msg.replyToMessageId`)
+ */
+export declare function getMessages(client: ITelegramClient, chatId: InputPeerLike, messageIds: MaybeArray<number>, fromReply?: boolean): Promise<(Message | null)[]>;

package/highlevel/methods/messages/get-reaction-users.d.ts

@@ -0,0 +1,24 @@
+import { ITelegramClient } from '../../client.types.js';
+import { ArrayPaginated, InputMessageId, InputReaction, PeerReaction } from '../../types/index.js';
+export type GetReactionUsersOffset = string;
+/**
+ * Get users who have reacted to the message.
+ *
+ * @param params
+ */
+export declare function getReactionUsers(client: ITelegramClient, params: InputMessageId & {
+    /**
+     * Get only reactions with the specified emoji
+     */
+    emoji?: InputReaction;
+    /**
+     * Limit the number of users returned.
+     *
+     * @default  100
+     */
+    limit?: number;
+    /**
+     * Offset for pagination
+     */
+    offset?: GetReactionUsersOffset;
+}): Promise<ArrayPaginated<PeerReaction, GetReactionUsersOffset>>;

package/highlevel/methods/messages/get-reply-to.d.ts

@@ -0,0 +1,10 @@
+import { ITelegramClient } from '../../client.types.js';
+import { Message } from '../../types/messages/index.js';
+/**
+ * For messages containing a reply, fetch the message that is being replied.
+ *
+ * Note that even if a message has {@link replyToMessage},
+ * the message itself may have been deleted, in which case
+ * this method will also return `null`.
+ */
+export declare function getReplyTo(client: ITelegramClient, message: Message): Promise<Message | null>;

package/highlevel/methods/messages/get-scheduled-messages.d.ts

@@ -0,0 +1,13 @@
+import { MaybeArray } from '../../../types/utils.js';
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike, Message } from '../../types/index.js';
+/**
+ * Get scheduled messages in chat by their IDs
+ *
+ * Fot messages that were not found, `null` will be
+ * returned at that position.
+ *
+ * @param chatId  Chat's marked ID, its username, phone or `"me"` or `"self"`
+ * @param messageIds  Scheduled messages IDs
+ */
+export declare function getScheduledMessages(client: ITelegramClient, chatId: InputPeerLike, messageIds: MaybeArray<number>): Promise<(Message | null)[]>;

package/highlevel/methods/messages/iter-history.d.ts

@@ -0,0 +1,23 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike, Message } from '../../types/index.js';
+import { getHistory } from './get-history.js';
+/**
+ * Iterate over chat history. Wrapper over {@link getHistory}
+ *
+ * @param chatId  Chat's marked ID, its username, phone or `"me"` or `"self"`.
+ * @param params  Additional fetch parameters
+ */
+export declare function iterHistory(client: ITelegramClient, chatId: InputPeerLike, params?: Parameters<typeof getHistory>[2] & {
+    /**
+     * Limits the number of messages to be retrieved.
+     *
+     * @default  Infinity, i.e. all messages
+     */
+    limit?: number;
+    /**
+     * Chunk size. Usually you shouldn't care about this.
+     *
+     * @default  100
+     */
+    chunkSize?: number;
+}): AsyncIterableIterator<Message>;

package/highlevel/methods/messages/iter-reaction-users.d.ts

@@ -0,0 +1,26 @@
+import { ITelegramClient } from '../../client.types.js';
+import { PeerReaction } from '../../types/index.js';
+import { getReactionUsers } from './get-reaction-users.js';
+/**
+ * Iterate over users who have reacted to the message.
+ *
+ * Wrapper over {@link getReactionUsers}.
+ *
+ * @param chatId  Chat ID
+ * @param messageId  Message ID
+ * @param params
+ */
+export declare function iterReactionUsers(client: ITelegramClient, params: Parameters<typeof getReactionUsers>[1] & {
+    /**
+     * Limit the number of events returned.
+     *
+     * @default  `Infinity`, i.e. all events are returned
+     */
+    limit?: number;
+    /**
+     * Chunk size, usually not needed.
+     *
+     * @default  100
+     */
+    chunkSize?: number;
+}): AsyncIterableIterator<PeerReaction>;

package/highlevel/methods/messages/iter-search-global.d.ts

@@ -0,0 +1,27 @@
+import { ITelegramClient } from '../../client.types.js';
+import { Message } from '../../types/index.js';
+import { searchGlobal } from './search-global.js';
+/**
+ * Search for messages globally from all of your chats.
+ *
+ * Iterable version of {@link searchGlobal}
+ *
+ * **Note**: Due to Telegram limitations, you can only get up to ~10000 messages
+ *
+ * @param params  Search parameters
+ */
+export declare function iterSearchGlobal(client: ITelegramClient, params?: Parameters<typeof searchGlobal>[1] & {
+    /**
+     * Limits the number of messages to be retrieved.
+     *
+     * @default  `Infinity`, i.e. all messages are returned
+     */
+    limit?: number;
+    /**
+     * Chunk size, which will be passed as `limit` parameter
+     * for `messages.search`. Usually you shouldn't care about this.
+     *
+     * @default  100
+     */
+    chunkSize?: number;
+}): AsyncIterableIterator<Message>;