# telegraf-develop

> Modern Telegram Bot Framework

Latest version **5.1.3** (published 2021-12-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install telegraf-develop
pnpm add telegraf-develop
yarn add telegraf-develop
bun add telegraf-develop
```

Provides the command `telegraf`.

## Health

**Score 35/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 5.1.3 |
| Published | 2021-12-09 |
| First published | 2021-12-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=10 |
| Dependencies | 6 |
| Unpacked size | 229.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 9203 |
| Author | Vitaly Domnikov |
| Maintainers | murka |
| Keywords | telegraf, telegram, telegram bot api, bot, botapi, bot framework |

## Links

- npm: https://www.npmjs.com/package/telegraf-develop
- Repository: https://github.com/telegraf/telegraf
- Homepage: https://github.com/telegraf/telegraf#readme
- Issues: https://github.com/telegraf/telegraf/issues
- npm.io page: https://npm.io/package/telegraf-develop

## Dependencies (6)

- [debug](https://npm.io/package/debug.md) ^4.0.1
- [minimist](https://npm.io/package/minimist.md) ^1.2.0
- [typegram](https://npm.io/package/typegram.md) ^3.6.2
- [node-fetch](https://npm.io/package/node-fetch.md) ^2.2.0
- [module-alias](https://npm.io/package/module-alias.md) ^2.2.2
- [sandwich-stream](https://npm.io/package/sandwich-stream.md) ^2.0.1

## Recent versions

- 5.1.3 (latest) — 2021-12-09
- 5.1.2 — 2021-12-09
- 5.1.1 — 2021-12-09
- 5.1.0 — 2021-12-09
- 5.0.0 — 2021-12-08

## README

![Telegraf](https://github.com/murka/telegraf-develop/docs/media/header.png)
[![Bot API Version](https://img.shields.io/badge/Bot%20API-v5.5-f36caf.svg?style=flat-square)](https://core.telegram.org/bots/api)
[![NPM Version](https://img.shields.io/npm/v/telegraf.svg?style=flat-square)](https://www.npmjs.com/package/telegraf-develop)
[![node](https://img.shields.io/node/v/telegraf.svg?style=flat-square)](https://www.npmjs.com/package/telegraf-develop)
[![Build Status](https://img.shields.io/travis/telegraf/telegraf.svg?branch=master&style=flat-square)](https://travis-ci.org/telegraf/telegraf)
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](http://standardjs.com/)
[![Community Chat](https://img.shields.io/badge/Community-Chat-blueChat?style=flat-square&logo=telegram)](https://t.me/TelegrafJSChat)

## Introduction

Bots are special [Telegram](https://telegram.org) accounts designed to handle messages automatically. Users can interact with bots by sending them command messages in private or group chats. These accounts serve as an interface for code running somewhere on your server.

### Features

- Full [Telegram Bot API 5.5](https://core.telegram.org/bots/api) support
- [Telegram Payment Platform](https://telegram.org/blog/payments)
- [HTML5 Games](https://core.telegram.org/bots/api#games)
- [Inline mode](https://core.telegram.org/bots/api#inline-mode)
- Incredibly fast
- [Vercel](https://vercel.com)/[Firebase](https://firebase.google.com/products/functions/)/[Glitch](https://dashing-light.glitch.me)/[Heroku](https://devcenter.heroku.com/articles/getting-started-with-nodejs#introduction)/[AWS **λ**](https://docs.aws.amazon.com/lambda/latest/dg/nodejs-prog-model-handler.html)/Whatever ready
- `http/https/fastify/Connect.js/express.js` compatible webhooks
- Easy to extend
- `TypeScript` typings

### Installation

```bash
npm install telegraf-develop
```

or using `yarn`:

```bash
yarn add telegraf-develop
```

### Documentation

[Telegraf developer docs](http://v5.telegrafjs.org)

### Examples
  
```js
const { Telegraf } = require('telegraf-develop')

const bot = new Telegraf(process.env.BOT_TOKEN)
bot.start((ctx) => ctx.reply('Welcome!'))
bot.help((ctx) => ctx.reply('Send me a sticker'))
bot.on('sticker', (ctx) => ctx.reply('👍'))
bot.hears('hi', (ctx) => ctx.reply('Hey there'))
bot.launch()
```

```js
const { Telegraf } = require('telegraf-develop')

const bot = new Telegraf(process.env.BOT_TOKEN)
bot.command('oldschool', (ctx) => ctx.reply('Hello'))
bot.command('modern', ({ reply }) => reply('Yo'))
bot.command('hipster', Telegraf.reply('λ'))
bot.launch()
```

There's some cool [examples too](docs/examples/).

---
_Source: https://npm.io/package/telegraf-develop · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._