@tgsnake/core
TypeScript icon, indicating that this package has built-in type declarations

1.10.8 • Public • Published

tgsnake core

Layer 173

Pure Telegram MTProto framework for Javascript or Typescript.

⚡ Using less dependencies to make it fast.
🔓 Open Source, you can contribute to make this framework better.
🗒️ Using Pure Telegram Raw Api, all JSON object is pure from telegram, nothing has changed at all. So that it makes it easier for you to learn the telegram schema docs.
🦕 Deno Support.

Example use

import { Client, Raw, Storages } from '@tgsnake/core';
process.env.LOGLEVEL = 'debug'; // set log level, see @tgsnake/log for more information.
const client = new Client(
  // you can fill with Telethon or Pyrogram string session.
  new Storages.StringSession(''),
  apiHash,
  apiId,
);
// handle update
client.addHandler((update) => {
  console.log(update);
});

// if you already pass the string session, don't fill any arguments in start function, leave it empty.
client.start({
  botToken: '', // if you want login as bot, you can login as user too.
  /* Remove "botToken" if you want to login as user.
  phoneNumber : async () => {}, // Phone number with international phone code (include plus sign (+)) will be used to login, the return of function must be a string.
  code : async () => {}, // OTP code, the return of function must be a string.
  password : async () => {}, // if you account has 2FA, the return of function must be a string.
  authError : async (error) => {} // when error BadRequest attempt, this function will be running.
  */
});

Exporting Session.

For exporting string session, use client.exportSession(). It will be return Promise<string>.

const exported = await client.exportSession();

Development Guidelines

  • Cloning Repository
$ git clone https://github.com/tgsnake/core
  • Installing Dependencies

Required to use yarn!

$ yarn install
  • Building TLSchema and Error class
$ yarn build:api
$ yarn build:error
  • Testing your app! Create test folder and you can create index.js file for testing the app. This folder will automatically ignored and not pushing to GitHub.

Notes

  • This framework is porting of pyrogram for connecting to telegram server. I have dedicated 2 months of my time to complete this framework from scratch. Research after research I do to improve this framework. So big thanks for pyrogram for the source, without that source code, this framework maybe unavailable.
  • For more questions, ask on telegram group (@tgsnake) or open github issue.

MIT License

Build with ♥️ by tgsnake dev.

Package Sidebar

Install

npm i @tgsnake/core

Weekly Downloads

7

Version

1.10.8

License

MIT

Unpacked Size

5.94 MB

Total Files

164

Last publish

Collaborators

  • butthx