@mtcute/core 0.16.0 → 0.16.3

package/README.md

@@ -39,11 +39,10 @@ const tg = new TelegramClient({
     // ... same options as above
 })
 
-tg.run({
+const self = await tg.start({
     phone: '+1234567890',
     code: () => prompt('Enter the code:'),
     password: 'my-password',
-}, async (user) => {
-    console.log(`✨ logged in as ${user.displayName}`)
 })
+console.log(`✨ logged in as ${self.displayName}`)
 ```

package/cjs/highlevel/client.d.ts

@@ -357,6 +357,7 @@ export interface TelegramClient extends ITelegramClient {
      *
      * @param params  Parameters to be passed to {@link start}
      * @param then  Function to be called after {@link start} returns
+     * @deprecated  This method provides no real value over {@link start}, please use it instead
      */
     run(params: Parameters<typeof start>[1], then?: (user: User) => void | Promise<void>): void;
     /**
@@ -1128,6 +1129,11 @@ export interface TelegramClient extends ITelegramClient {
         chatId: InputPeerLike;
         /** User/channel ID whose messages to delete */
         participantId: InputPeerLike;
+        /**
+         * Whether to dispatch the updates that will be generated by this call.
+         * Doesn't follow `disableNoDispatch`
+         */
+        shouldDispatch?: true;
     }): Promise<void>;
     /**
      * Edit supergroup/channel admin rights of a user.
@@ -2172,7 +2178,13 @@ export interface TelegramClient extends ITelegramClient {
      * @param chat  Chat or user ID, username, phone number, `"me"` or `"self"`
      * @param topicId  ID of the topic (i.e. its top message ID)
      */
-    deleteForumTopicHistory(chat: InputPeerLike, topicId: number | ForumTopic): Promise<void>;
+    deleteForumTopicHistory(chat: InputPeerLike, topicId: number | ForumTopic, params?: {
+        /**
+         * Whether to dispatch updates that will be generated by this call.
+         * Doesn't follow `disableNoDispatch`
+         */
+        shouldDispatch?: true;
+    }): Promise<void>;
     /**
      * Modify a topic in a forum
      *
@@ -3149,6 +3161,11 @@ export interface TelegramClient extends ITelegramClient {
          * Whether to also clear all mentions in the chat
          */
         clearMentions?: boolean;
+        /**
+         * Whether to dispatch updates that will be generated by this call.
+         * Doesn't follow `disableNoDispatch`
+         */
+        shouldDispatch?: true;
     }): Promise<void>;
     /**
      * Mark all reactions in chat as read.
@@ -3157,7 +3174,13 @@ export interface TelegramClient extends ITelegramClient {
      *
      * @param chatId  Chat ID
      */
-    readReactions(chatId: InputPeerLike): Promise<void>;
+    readReactions(chatId: InputPeerLike, params?: {
+        /**
+         * Whether to dispatch updates that will be generated by this call.
+         * Doesn't follow `disableNoDispatch`
+         */
+        shouldDispatch?: true;
+    }): Promise<void>;
     /**
      * Search for messages globally from all of your chats
      *
@@ -3641,6 +3664,11 @@ export interface TelegramClient extends ITelegramClient {
          * For forums - unpin only messages from the given topic
          */
         topicId?: number;
+        /**
+         * Whether to dispatch updates that will be generated by this call.
+         * Doesn't follow `disableNoDispatch`
+         */
+        shouldDispatch?: true;
     }): Promise<void>;
     /**
      * Unpin a message in a group, supergroup, channel or PM.