This project provides TypeScript types for the entire Telegram API in version 4.9 which was released on June 4, 2020.
Generally this package just exposes a huge load of interfaces as well as a single class Telegram which contains all available methods of the API.
There is no further structure applied to this, but if you can come up with something reasonable, please suggest it in an issue or directly open a PR.
All of the methods are specified with the actual return type of the Telegram API.
If you need them to return Promises instead, consider using TelegramP.
This type maps all methods of Telegram to a promisified version.
Each method takes just a single argument with a structure that corresponds to the object expected by Telegram.
If you need to directly access that type, consider using Opts<M> where M is the method name (e.g. Opts<'getMe'>).
They're handwritten.
That is, they're of course not entirely handwritten. The initial version of them were produced in one afternoon by a combination of copying and pasting from the website, VIM magic, regular expressions and VSCode auto-formatting the rest.
Previous attempts to harvest them directly from the website in an automated fashion failed due to the required effort of handling special cases.
Future updates to the API will be integrated manually in a similar fashion.
FAQs
Type declarations for the Telegram API
The npm package typegram receives a total of 11,070 weekly downloads. As such, typegram popularity was classified as popular.
We found that typegram demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The Socket Research team breaks down a malicious npm package targeting the legitimate DOMPurify library. It uses obfuscated code to hide that it is exfiltrating browser and crypto wallet data.
Security News
ENISA’s 2024 report highlights the EU’s top cybersecurity threats, including rising DDoS attacks, ransomware, supply chain vulnerabilities, and weaponized AI.
Security News
NIST's new password guidelines remove periodic changes and special character requirements, focusing on longer, more secure passwords for better authentication practices.
