History

mtcute-bot 1d12f807c2 All checks were successful Tests / lint (push) Has been skipped Details Tests / test-node (node20) (push) Successful in 1m31s Details Tests / test-node (node22) (push) Successful in 1m37s Details Tests / test-web (chromium) (push) Successful in 1m37s Details Tests / test-deno (push) Successful in 1m43s Details Tests / test-web (firefox) (push) Successful in 1m43s Details Tests / test-bun (push) Successful in 1m53s Details Tests / test-node (node18) (push) Successful in 4m7s Details Tests / e2e (push) Has been skipped Details Tests / e2e-deno (push) Has been skipped Details Docs / build (push) Successful in 14m25s Details chore(release): v0.19.3		2025-01-06 15:10:21 +00:00
..
src	fix: fixed deno types and build	2025-01-01 21:55:42 +03:00
build.config.js	build: bumped typedoc and moved to `fuman-build typedoc`	2024-12-28 11:25:22 +03:00
package.json	chore(release): v0.19.3	2025-01-06 15:10:21 +00:00
README.md	chore: deprecated `.run` method	2024-07-26 06:46:18 +03:00
tsconfig.json	build: build with vite (initial)	2024-08-24 22:55:25 +03:00

README.md

@mtcute/node

📖 API Reference

Node.js support package for mtcute. Includes:

Support for native crypto addon (must be installed separately, @mtcute/crypto-node)
Terminal I/O via readline
SQLite storage (via better-sqlite3)
TCP transport (via node:net)
TelegramClient implementation using the above
HTML and Markdown parsers

Usage

import { TelegramClient } from '@mtcute/node'

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

const self = await tg.start()
console.log(`✨ logged in as ${self.displayName}`)