History

Alina Sireneva 871f161694 docs: updated packages readmes		2023-11-01 14:05:45 +03:00
..
src	docs: use `@default` jsdoc tag	2023-10-29 20:25:06 +03:00
tests	fix(core): allow empty startgroup parameter	2023-10-23 19:17:04 +03:00
.gitignore	tests(core): added e2e and fuzzing tests	2021-06-15 03:12:22 +03:00
package.json	ci: release building	2023-11-01 01:03:49 +03:00
README.md	docs: updated packages readmes	2023-11-01 14:05:45 +03:00
tsconfig.json	docs: updated typedoc, added ci, fixed some docs	2023-10-27 14:25:21 +03:00
typedoc.cjs	docs: updated typedoc, added ci, fixed some docs	2023-10-27 14:25:21 +03:00
utils.ts	ESM + end-to-end tests (#11 )	2023-10-16 19:23:53 +03:00

README.md

@mtcute/core

📖 API Reference

Basic low-level MTProto implementation and auxiliary utilities.

Features

MTProto 2.0: Implements the full MTProto protocol, including all the encryption and serialization
2FA support: Provides utilities for 2-step verification
Hackable: Bring your own storage, transport, and other components to customize the library to your needs
Magical: Handles reconnections, connection pooling, DC redirections and other stuff for you
Web support: Works in the browser with no additional configuration

Usage

import { BaseTelegramClient } from '@mtcute/core'

const tg = new BaseTelegramClient({
    apiId: 12345,
    apiHash: '0123456789abcdef0123456789abcdef',
})

tg.call({ _: 'help.getConfig' })
    .then(console.log)