@mtcute/client

@mtcute/client

📖 API Reference

High-level Telegram client implementation over the @mtcute/core base library.

Features

• Updates handling: Implements proper updates handling, including ordering and gap recovery (learn more)
• Wrapper classes: Easy-to-use classes that wrap the complex TL objects and provide a clean interface
• High-level methods: Methods that wrap the low-level API calls and provide a clean interface
• Tree-shaking: Only import the methods you need, and the rest will not be included into the bundle
• Web support: Works in the browser with no additional configuration

Usage

import { TelegramClient } from '@mtcute/client'

const tg = new TelegramClient({
    apiId: 12345,
    apiHash: '0123456789abcdef0123456789abcdef',
    // ... + supports all options from @mtcute/core ...
})

tg.start({
    phone: '[phone]',
    password: () => prompt('Enter password'),
    code: () => prompt('Enter code'),
}, (user) => {
    console.log(`Logged in as ${user.displayName}`)
})

Note: for web, prefer BaseTelegramClient over TelegramClient, as it is tree-shakeable – learn more