Skip to content

prKassad/telegram-webapps-types

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 

Repository files navigation

Telegram Web Apps for Bots TypeScript typings

TypeScript typings for Telegram Web Apps for Bots. See https://core.telegram.org/bots/webapps

Usage

Install the package

Using npm

npm install telegram-webapps-types

If you are working on a TypeScript project

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

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

If you are working on a JavaScript project

This step does not add types to your project, but it improves your autocompletion experience. This typically works with all modern editors & IDEs. If you encounter an issue, check the documentation for your editor.

  1. Create the jsconfig.json file at the root of your project.

  2. Add the following

{
  "compilerOptions": {
    "typeRoots": [
      "./node_modules/@types",
      "./node_modules/telegram-webapps-types"
    ]
  }
}
  1. You should be able to get autocompletion working inside your JavaScript project.