@botocrat/telegram/README.MD

Simple, light-weight Telegram Bot Client for Node.js.

# Telegram Bot Client

Simple, light-weight Telegram Bot Client for Node.js.

[![NodeJS][nodejs-image]][npm-url]
[![npm][npm-image]][npm-url]
[![telegram 5.7][telegram-image]][telegram-url]
[![quality][npm-quality-image]][npm-url]
[![license mit][license-image]][github-url]

[![last commit][lastcommit-image]][github-url]
[![size][size-image]][npm-url]
[![vulnerabilities][vulnerabilities-image]][npm-url]
[![Total alerts][alerts-image]][alerts-url]
[![Code quality][quality-image]][quality-url]

This library is part of [Botocrat Framework][framework-url] and can work as a standalone library.

## What's the difference?

- You don't have to think about the order of the arguments, same as [official API][telegram-url]
- [Lightest weight][size-comparison] (< 5 kb)
- Minimal dependencies
- Future-proof (Only types will added on Telegram API changes)
- [Bent][bent-url] as http requester

## What's missing?

This library intented to make requests to Telegram Bot API server and handling responses only. Handling updates from telegram or other high level features is not a purpose of this library. Use the [framework][framework-url] to receive and handle updates.

## Getting started

```bash
npm i @botocrat/telegram --save
```

```javascript
import createClient from '@botocrat/telegram'

const client = createClient({token: '123456789:BB...'})

const me = await client.getMe()

```

### TypeScript Support

```typescript
import createClient, {ITMessage} from '@botocrat/telegram'

const client = createClient({token: '123456789:BB...'})

const Message: ITMessage = {
  chat_id: -11111111, 
  text: "Hello", 
  protect_content: true
}
const sent = await client.sendMessage(Message)
```

### Feature: Download File From Telegram

```typescript
...
const [data, ext, size] = await client
  .getFile(incomingMessage.photo)
  .then(client.download) // Buffer

fs.writeFileSync("fileName." + ext, data)
...
```

### Feature: Intercepting request

You can intercept the request by defining interceptor. This feature is implemented for logging purpose and it's optional.

```typescript
...
const client = createClient({
  token: '123456789:BB...',
  interceptor: (method, params, formData) => {
    console.log(`${method} called | ${Date.now()}`)
  }})
...
```

## Parameters

### Required

| Param | Description |
|-|-|
| token | Telegram bot token |

### Optional

| Param | Description | Default |
|-|-|-|
| debug | Debug function | null |
| baseUri | Telegram API url | _https://api.telegram.org_ |
| fileSizeLimit | Size limiter for .download() method | Infinity (no limit) |
| interceptor | callback to intercept request before sent | null |

No need for extra documentation, all API methods and parameters explained in `Official Telegram Bot API Documentation`

## Resources

- [Official Telegram Bot API Documentation][telegram-url]

### License

MIT License

[license-image]: https://img.shields.io/github/license/botocrats/telegram?style=flat-square
[size-image]: https://img.shields.io/bundlephobia/minzip/@botocrat/telegram?style=flat-square
[npm-quality-image]: https://img.shields.io/npms-io/quality-score/@botocrat/telegram?style=flat-square
[nodejs-image]: https://img.shields.io/badge/library-NodeJS-darkgreen.svg?style=flat-square
[telegram-image]: https://img.shields.io/github/package-json/api-version/botocrats/telegram?label=telegram%20bot%20api%20&logo=telegram
[npm-image]: https://img.shields.io/npm/v/@botocrat/telegram.svg?style=flat-square
[lastcommit-image]: https://img.shields.io/github/last-commit/botocrats/telegram?style=flat-square
[vulnerabilities-image]: https://img.shields.io/snyk/vulnerabilities/npm/@botocrat/telegram

[telegram-url]: https://core.telegram.org/bots/api#january-31-2022
[npm-url]: https://npmjs.org/package/@botocrat/telegram
[github-url]: https://github.com/botocrats/telegram
[bent-url]: https://github.com/mikeal/bent
[size-comparison]: https://packagephobia.com/result?p=%40botocrat%2Ftelegram%2Ctelegraf%2Cnode-telegram-bot-api%2Cslimbot%2Ctelebot
[framework-url]: https://npmjs.org/package/@botocrat/core
[alerts-url]: https://lgtm.com/projects/g/botocrats/telegram/alerts/
[alerts-image]: https://img.shields.io/lgtm/alerts/g/botocrats/telegram.svg?logo=lgtm&logoWidth=18
[quality-image]: https://img.shields.io/lgtm/grade/javascript/g/botocrats/telegram.svg?logo=lgtm&logoWidth=18
[quality-url]: https://lgtm.com/projects/g/botocrats/telegram/context:javascript