mtcute/packages/node
2024-04-27 12:19:08 +03:00
..
src build: added deprecation notice to commonjs builds 2024-04-27 12:19:08 +03:00
build.config.cjs build: extracted custom build config to packages themselves 2023-11-02 21:23:17 +03:00
package.json build(node): bumped better-sqlite3 2024-04-27 12:19:07 +03:00
README.md docs: updated node readme 2024-03-23 23:52:11 +03:00
tsconfig.json chore!: moved @mtcute/sqlite into @mtcute/node 2024-03-20 13:52:50 +03:00
typedoc.cjs docs: updated readmes 2024-03-07 05:35:37 +03:00

@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'
})

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