Module @mtcute/web - v0.13.0

@mtcute/web

📖 API Reference

Web support package for mtcute. Includes:

  • WASM crypto provider
  • Websocket transport
  • IndexedDB storage
  • TelegramClient implementation using the above

Usage

import { TelegramClient } from '@mtcute/web'

const tg = new TelegramClient({
apiId: 12345,
apiHash: 'abcdef',
storage: 'my-account'
})

tg.run(async (user) => {
console.log(`✨ logged in as ${user.displayName}`)
})

Usage with workers

You can also use this package with web workers to offload most of the heavy lifting to a separate thread:

// worker.ts
import { BaseTelegramClient, TelegramWorker } from '@mtcute/web'

const client = new BaseTelegramClient({
apiId: 12345,
apiHash: 'abcdef',
storage: 'my-account'
})

new TelegramWorker({ client })

// main.ts
import { TelegramClient, TelegramWorkerPort } from '@mtcute/web'

const worker = new Worker(new URL('./worker.ts', import.meta.url), { type: 'module' }) // or SharedWorker
const port = new TelegramWorkerPort({ worker })
const tg = new TelegramClient({ client: port })

tg.run({}, async (user) => {
console.log(`✨ logged in as ${user.displayName}`)
})

Index

Classes

Interfaces

Type Aliases

Generated using TypeDoc