Typings for Telegram Mini Apps
---
About Telegram Mini Apps
---
## Usage
### Installation
via `npm` :
```bash
npm install telegram-webapps --save-dev
```
via `yarn` :
```bash
yarn add -D telegram-webapps
```
via `pnpm` :
```bash
pnpm add -D telegram-webapps
```
### Use typings
Include the types file inside your [ `tsconfig.json` ](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html) file like this:
```diff
{
"compilerOptions": {
"types": [
+ "./node_modules/telegram-webapps"
]
}
}
```
Use `Telegram` constant inside your client-side code to get `WebApp` object:
```typescript
// informs the Telegram app that the Web App is ready to be displayed
Telegram.WebApp.ready()
```