Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wfjsw/node-tdlib
TDLib Binding with Telegram Bot API Reimplemention for Node.js
https://github.com/wfjsw/node-tdlib
bindings node-tdlib nodejs tdlib telegram telegram-api telegram-bot-api
Last synced: about 22 hours ago
JSON representation
TDLib Binding with Telegram Bot API Reimplemention for Node.js
- Host: GitHub
- URL: https://github.com/wfjsw/node-tdlib
- Owner: wfjsw
- License: unlicense
- Created: 2018-05-26T00:45:59.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-07T18:50:50.000Z (almost 2 years ago)
- Last Synced: 2024-04-14T20:25:09.963Z (7 months ago)
- Topics: bindings, node-tdlib, nodejs, tdlib, telegram, telegram-api, telegram-bot-api
- Language: JavaScript
- Homepage:
- Size: 433 KB
- Stars: 37
- Watchers: 5
- Forks: 3
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# node-tdlib
## Install
### Use prebuilt binaries
```
npm i wfjsw/node-tdlib --save
```
NPM will automatically download the appropriate `tdlib.node` binary.
Will compile automatically (using a lot of time) if there doesn't exist a suitable binary. If you do not need it, pass `--ignore-scripts` to `npm`.
List of prebuilt binary is available [here](https://github.com/wfjsw/node-tdlib/releases).
### Compile on your own
```
git clone https://github.com/wfjsw/node-tdlib.git
cd node-tdlib
npm i
npm run compile
npm ln
```
When you need to use it, run
```
npm ln tdlib
```
Dependencies: cmake, gperf, zlib, node >= 10.0.0, same OpenSSL(libssl-dev) version with Node.js
You may check your Node.js Dependency by using `node -p process.versions`
Be careful when use `gcc` and `g++` as they will use up to 8GB memory. `clang` compiler is preferred but not required. Using `clang` will result in less memory requirement on compilation.
Optional Dependencies: ccache (will speed up subsequent compilation.)
## TdLib Raw Interface
```typescript
interface TDLib {
/**
* Create a TDLib Client
* @returns {number} Return a sequence number for client identifier
*/
td_client_create(): number;
/**
* Destroy a TDLib Client
* @param {number} client_id Client identifier
*/
td_client_destroy(client_id: number);
/**
* Sends request to TDLib.
* @param {number} client_id Client identifier
* @param {string} request JSON serialized request
*/
td_client_send(client_id: number, request: string);
/**
* Receives incoming updates and request responses from TDLib.
* @param {number} client_id Client identifier
* @param {number} timeout Maximum number of seconds allowed for this function to wait for new data.
*/
td_client_receive(client_id: number, timeout: number);
/**
* Sends synchronized request to TDLib.
* @param client_id Client identifier
* @param request JSON serialized request
*/
td_client_execute(client_id: number, request: string): string;
}
```
## TdClient Interface
See [TDLib Documentation](https://core.telegram.org/tdlib/docs/annotated.html) for further reference.
```typescript
class TdClientActor extends EventEmitter {
constructor(options: TdClientActorOptions);
run(method: string, params: object): Promise;
destroy(): Promise;
// Events:
// ready
// closed
// __
// _fileDownloaded
// _fileDownloaded:
}
interface TdClientActorOptions {
identifier: string;
database_encryption_key: string;
/** Application identifier for Telegram API access, which can be obtained at https://my.telegram.org. */
api_id: string;
/** Application identifier hash for Telegram API access, which can be obtained at https://my.telegram.org. */
api_hash: string;
/** If set to true, the Telegram test environment will be used instead of the production environment. */
use_test_dc?: boolean;
/** The path to the directory for the persistent database; if empty, a dedicated directory named in identifier will be used. */
database_directory?: string;
/** If set to true, information about downloaded and uploaded files will be saved between application restarts. */
use_file_database?: boolean;
/** If set to true, the library will maintain a cache of users, basic groups, supergroups, channels and secret chats. Implies use_file_database. */
use_chat_info_database?: boolean;
/** If set to true, the library will maintain a cache of chats and messages. Implies use_chat_info_database. */
use_message_database?: boolean;
/** If set to true, support for secret chats will be enabled. */
use_secret_chats?: boolean;
/** IETF language tag of the user's operating system language; must be non-empty. */
system_language_code?: string;
/** Model of the device the application is being run on; must be non-empty. */
device_model?: string;
/** Version of the operating system the application is being run on; must be non-empty. */
system_version?: string;
/** Application version; must be non-empty. */
application_version?: string;
/** If set to true, old files will automatically be deleted. */
enable_storage_optimizer?: string;
/** If set to true, original file names will be ignored. Otherwise, downloaded files will be saved under names as close as possible to the original name. */
ignore_file_names?: boolean;
}
```
## Bot API Interface
See [Telegram Bot API](https://core.telegram.org/bots/api) and bundled TypeScript file for reference.
## License
This is free and unencumbered software released into the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or
distribute this software, either in source code form or as a compiled
binary, for any purpose, commercial or non-commercial, and by any
means.