telegram-bot-api-jsdoc

telegram-bot-api-jsdoc

Telegram Bot API SDK compiled size is 0KB that only includes type definition files and JSDoc files. It can be used to conveniently develop Telegram Bots in TypeScript and JavaScript. You can wrap your API client with as many web request libraries as you want.

This is a jsdoc file for Telegram Bot API. It is based on the official Telegram Bot API documentation.

Installation

npm i telegram-bot-api-jsdoc --save-dev # jsdoc for JavaScript

Example

You can use any HTTP request library you want to encapsulate your API client. Here is a simple echo bot.

import 'telegram-bot-api-jsdoc' // Import the jsdoc file
import * as fs from 'node:fs';

class APIClientBase {
    // Implement your request method
    // you can use any http request library you want
    // You can go to `test` to see an example of the implementation
}

/**
 * @param token
 * @returns {APIClientBase & AllBotMethods}
 */
export function createAPIClient(token) {
    const client = new APIClientBase(token);
    return new Proxy(client, {
        get(target, prop, receiver) {
            if (prop in target) {
                return Reflect.get(target, prop, receiver);
            }
            return (...args) => {
                if (typeof prop === 'string' && prop.endsWith('WithReturns')) {
                    const method = prop.slice(0, -11);
                    return Reflect.apply(target.requestJSON, target, [method, ...args]);
                }
                return Reflect.apply(target.request, target, [prop, ...args]);
            };
        }
    });
}

async function main() {
    const client = createAPIClient(token);
    const {result: user} = await client.getMeWithReturns()
    console.log(`Hello! My name is ${user.username}`);
    await client.deleteWebhook();
    let offset = 0
    while (true) {
        const {result: updates} = await client.getUpdatesWithReturns({offset: offset});
        for (const update of updates) {
            offset = update.update_id + 1;
            if (update.message?.text) {
                await client.sendMessageWithReturns({chat_id: update.message.chat.id, text: update.message.text});
            }
        }
    }
}

main().catch(console.error);

You don't need to implement the methods one by one, you can use the Proxy object to create a client that automatically calls the methods. You can find the implementation of the APIClientBase class in the test folder.

License

telegram-bot-api-types is released under the MIT license. See LICENSE for details.