@mtkruto/node 0.1.106 → 0.1.107

package/script/client/4_client.js

@@ -1243,9 +1243,10 @@ class Client extends _1_client_abstract_js_1.ClientAbstract {
     /**
      * Send a text message.
      *
+     * @method
      * @param chatId The chat to send the message to.
      * @param text The message's text.
-     * @method
+     * @returns The sent text message.
      */
     async sendMessage(chatId, text, params) {
         const [message, entities] = this.parseText(text, params);
@@ -1296,10 +1297,11 @@ class Client extends _1_client_abstract_js_1.ClientAbstract {
     /**
      * Edit a message's text.
      *
+     * @method
      * @param chatId The chat where the message is.
      * @param messageId The ID of the message.
      * @param text The new text of the message.
-     * @method
+     * @returns The edited text message.
      */
     async editMessageText(chatId, messageId, text, params) {
         const [message, entities] = this.parseText(text, params);
@@ -1354,12 +1356,16 @@ class Client extends _1_client_abstract_js_1.ClientAbstract {
     /**
      * Retrieve multiple messages.
      *
+     * @method
      * @param chatId The identifier of the chat to retrieve the messages from.
      * @param messageIds The identifiers of the messages to retrieve.
-     * @method
+     * @example ```ts
+     * const message = await client.getMessages("@MTKruto", [210, 212]);
+     * ```
+     * @returns The retrieved messages.
      */
-    async getMessages(chatId_, messageIds) {
-        return await this.getMessagesInner(chatId_, messageIds).then((v) => v.map((v) => v.message));
+    async getMessages(chatId, messageIds) {
+        return await this.getMessagesInner(chatId, messageIds).then((v) => v.map((v) => v.message));
     }
     async [getMessageWithReply](chatId, messageId) {
         const messages = await this.getMessagesInner(chatId, [messageId]);
@@ -1368,9 +1374,13 @@ class Client extends _1_client_abstract_js_1.ClientAbstract {
     /**
      * Retrieve a single message.
      *
+     * @method
      * @param chatId The identifier of the chat to retrieve the message from.
      * @param messageId The identifier of the message to retrieve.
-     * @method
+     * @example ```ts
+     * const message = await client.getMessage("@MTKruto", 212);
+     * ```
+     * @returns The retrieved message.
      */
     async getMessage(chatId, messageId) {
         const messages = await this.getMessages(chatId, [messageId]);
@@ -1420,8 +1430,14 @@ class Client extends _1_client_abstract_js_1.ClientAbstract {
     /**
      * Download a file.
      *
-     * @param fileId The identifier of the file to download.
      * @method
+     * @param fileId The identifier of the file to download.
+     * @example ```ts
+     * for await (const chunk of client.download(fileId, { chunkSize: 256 * 1024 })) {
+     *   await outFile.write(chunk);
+     * }
+     * ```
+     * @returns A generator yielding the contents of the file.
      */
     async download(fileId, params) {
         const fileId_ = _3_types_js_1.FileID.decode(fileId);
@@ -1463,10 +1479,11 @@ class Client extends _1_client_abstract_js_1.ClientAbstract {
     /**
      * Forward multiple messages.
      *
+     * @method
      * @param from The identifier of the chat to forward the messages from.
      * @param to The identifier of the chat to forward the messages to.
      * @param messageIds The identifiers of the messages to forward.
-     * @method
+     * @returns The forwarded messages.
      */
     async forwardMessages(from, to, messageIds, params) {
         const result = await this.invoke(new _2_tl_js_1.functions.MessagesForwardMessages({
@@ -1486,10 +1503,11 @@ class Client extends _1_client_abstract_js_1.ClientAbstract {
     /**
      * Forward a single message.
      *
+     * @method
      * @param from The identifier of the chat to forward the message from.
      * @param to The identifier of the chat to forward the message to.
      * @param messageId The identifier of the message to forward.
-     * @method
+     * @returns The forwarded message.
      */
     async forwardMessage(from, to, messageId, params) {
         return await this.forwardMessages(from, to, [messageId], params).then((v) => v[0]);
@@ -1605,8 +1623,8 @@ class Client extends _1_client_abstract_js_1.ClientAbstract {
     /**
      * Answer a callback query. Bot-only.
      *
-     * @param id ID of the callback query to answer.
      * @method
+     * @param id ID of the callback query to answer.
      */
     async answerCallbackQuery(id, params) {
         await this.assertBot("answerCallbackQuery");
@@ -1632,10 +1650,11 @@ class Client extends _1_client_abstract_js_1.ClientAbstract {
     /**
      * Send a poll.
      *
+     * @method
      * @param chatId The chat to send the poll to.
      * @param question The poll's question.
      * @param options The poll's options.
-     * @method
+     * @returns The sent poll.
      */
     async sendPoll(chatId, question, options, params) {
         const peer = await this.getInputPeer(chatId);
@@ -1685,57 +1704,57 @@ class Client extends _1_client_abstract_js_1.ClientAbstract {
     /**
      * Send a chat action.
      *
+     * @method
      * @param chatId The chat to send the chat action to.
      * @param action The chat action.
      * @param messageThreadId The thread to send the chat action to.
-     * @method
      */
-    async sendChatAction(chatId, action_, messageThreadId) {
-        let action;
-        switch (action_) {
+    async sendChatAction(chatId, action, params) {
+        let action_;
+        switch (action) {
             case "type":
-                action = new _2_tl_js_1.types.SendMessageTypingAction();
+                action_ = new _2_tl_js_1.types.SendMessageTypingAction();
                 break;
             case "uploadPhoto":
-                action = new _2_tl_js_1.types.SendMessageUploadPhotoAction({ progress: 0 });
+                action_ = new _2_tl_js_1.types.SendMessageUploadPhotoAction({ progress: 0 });
                 break;
             case "recordVideo":
-                action = new _2_tl_js_1.types.SendMessageRecordVideoAction();
+                action_ = new _2_tl_js_1.types.SendMessageRecordVideoAction();
                 break;
             case "uploadVideo":
-                action = new _2_tl_js_1.types.SendMessageRecordVideoAction();
+                action_ = new _2_tl_js_1.types.SendMessageRecordVideoAction();
                 break;
             case "recordVoice":
-                action = new _2_tl_js_1.types.SendMessageRecordAudioAction();
+                action_ = new _2_tl_js_1.types.SendMessageRecordAudioAction();
                 break;
             case "uploadAudio":
-                action = new _2_tl_js_1.types.SendMessageUploadAudioAction({ progress: 0 });
+                action_ = new _2_tl_js_1.types.SendMessageUploadAudioAction({ progress: 0 });
                 break;
             case "uploadDocument":
-                action = new _2_tl_js_1.types.SendMessageUploadDocumentAction({ progress: 0 });
+                action_ = new _2_tl_js_1.types.SendMessageUploadDocumentAction({ progress: 0 });
                 break;
             case "chooseSticker":
-                action = new _2_tl_js_1.types.SendMessageChooseStickerAction();
+                action_ = new _2_tl_js_1.types.SendMessageChooseStickerAction();
                 break;
             case "findLocation":
-                action = new _2_tl_js_1.types.SendMessageGeoLocationAction();
+                action_ = new _2_tl_js_1.types.SendMessageGeoLocationAction();
                 break;
             case "recordVideoNote":
-                action = new _2_tl_js_1.types.SendMessageRecordRoundAction();
+                action_ = new _2_tl_js_1.types.SendMessageRecordRoundAction();
                 break;
             case "uploadVideoNote":
-                action = new _2_tl_js_1.types.SendMessageUploadRoundAction({ progress: 0 });
+                action_ = new _2_tl_js_1.types.SendMessageUploadRoundAction({ progress: 0 });
                 break;
             default:
-                throw new Error("Invalid chat action: " + action_);
+                throw new Error("Invalid chat action: " + action);
         }
-        await this.invoke(new _2_tl_js_1.functions.MessagesSetTyping({ peer: await this.getInputPeer(chatId), action, topMsgId: messageThreadId }));
+        await this.invoke(new _2_tl_js_1.functions.MessagesSetTyping({ peer: await this.getInputPeer(chatId), action: action_, topMsgId: params?.messageThreadId }));
     }
     /**
      * Upload a file.
      *
-     * @param contents The contents of the file.
      * @method
+     * @param contents The contents of the file.
      */
     async upload(contents, params) {
         const isBig = contents.length > 1048576; // 10 MB
@@ -1825,8 +1844,8 @@ class Client extends _1_client_abstract_js_1.ClientAbstract {
     /**
      * Set the bot's commands in the given scope and/or language. Bot-only.
      *
-     * @param commands The commands to set.
      * @method
+     * @param commands The commands to set.
      */
     async setMyCommands(commands, params) {
         await this.invoke(new _2_tl_js_1.functions.BotsSetBotCommands({
@@ -1848,9 +1867,9 @@ class Client extends _1_client_abstract_js_1.ClientAbstract {
     /**
      * Answer an inline query. Bot-only.
      *
+     * @method
      * @param id The ID of the inline query to answer.
      * @param results The results to answer with.
-     * @method
      */
     async answerInlineQuery(id, results, params) {
         await this.invoke(new _2_tl_js_1.functions.MessagesSetInlineBotResults({
@@ -1948,27 +1967,27 @@ class Client extends _1_client_abstract_js_1.ClientAbstract {
      *
      * @method
      */
-    async getMyDescription(languageCode) {
+    async getMyDescription(params) {
         await this.assertBot("getMyDescription");
-        return await this.getMyInfo(languageCode).then((v) => v.description);
+        return await this.getMyInfo(params?.languageCode).then((v) => v.description);
     }
     /**
      * Set the bot's name in the given language. Bot-only.
      *
      * @method
      */
-    async getMyName(languageCode) {
+    async getMyName(params) {
         await this.assertBot("getMyName");
-        return await this.getMyInfo(languageCode).then((v) => v.description);
+        return await this.getMyInfo(params?.languageCode).then((v) => v.description);
     }
     /**
      * Get the bot's short description in the given language. Bot-only.
      *
      * @method
      */
-    async getMyShortDescription(languageCode) {
+    async getMyShortDescription(params) {
         await this.assertBot("getMyShortDescription");
-        return await this.getMyInfo(languageCode).then((v) => v.about);
+        return await this.getMyInfo(params?.languageCode).then((v) => v.about);
     }
 }
 exports.Client = Client;