History

Alina Sireneva 02a6a0e133 fix(core): proper exit cleanup in json file		2023-12-19 02:24:19 +03:00
..
src	fix(core): proper exit cleanup in json file	2023-12-19 02:24:19 +03:00
.gitignore	tests(core): added e2e and fuzzing tests	2021-06-15 03:12:22 +03:00
build.config.cjs	build: extracted custom build config to packages themselves	2023-11-02 21:23:17 +03:00
package.json	fix(core): proper exit cleanup in json file	2023-12-19 02:24:19 +03:00
README.md	docs: updated packages readmes	2023-11-01 14:05:45 +03:00
tsconfig.json	test(client): test coverage for client utils	2023-11-16 02:42:02 +03:00
typedoc.cjs	chore: moved most configs to .config	2023-11-13 13:28:11 +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)