davisdmitry/telegram-webapps

TypeScript typings for Telegram Mini Apps

Typings for Telegram Mini Apps

---

About Telegram Mini Apps

---

Usage

Instal

via npm :

npm install telegram-webapps --save-dev

via yarn :

yarn add -D telegram-webapps

via pnpm :

pnpm add -D telegram-webapps

Use typings

Include the types file inside your tsconfig.json file like this:

{
  "compilerOptions": {
    "typeRoots": [
+     "./node_modules/telegram-webapps"
    ]
  }
}

Use Telegram constant inside your client-side code to get WebApp object:

// informs the Telegram app that the Web App is ready to be displayed
Telegram.WebApp.ready()

telegram-webapps's Issues

Missing properties in `WebAppInitData`

Thanks for a useful library! Just a heads-up, the WebAppInitData type is currently missing at least the following properties listed in https://core.telegram.org/bots/webapps#webappinitdata:

• chat_type?: string
• chat_instance?: string

Fields of WebAppUser interface

Why are the fields is_premium, allows_write_to_pm and added_to_attachment_menu set to type true? Isn't it better to set them to boolean?

typo in variable name (Telegram.WebApp.BackButton.isVisible)