https://github.com/sergeysova/telegram-typings

Flow, TypeScript, Rust types for Telegram Bots API
https://github.com/sergeysova/telegram-typings

crate flowtype javascript rust telegram telegram-bot typescript

Last synced: 5 days ago
JSON representation

Flow, TypeScript, Rust types for Telegram Bots API

• Host: GitHub
• URL: https://github.com/sergeysova/telegram-typings
• Owner: sergeysova
• License: mit
• Created: 2017-12-19T09:32:04.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2022-12-02T01:57:50.000Z (almost 2 years ago)
• Last Synced: 2024-04-25T12:43:18.710Z (7 months ago)
• Topics: crate, flowtype, javascript, rust, telegram, telegram-bot, typescript
• Language: Rust
• Homepage:
• Size: 1.03 MB
• Stars: 40
• Watchers: 4
• Forks: 9
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • Changelog: changelog.md
  • License: license

Awesome Lists containing this project

README

        
# Telegram Bot API typings for Flow, TypeScript and Rust

![Travis (.org)](https://img.shields.io/travis/sergeysova/telegram-typings.svg?style=for-the-badge) ![npm](https://img.shields.io/npm/dt/telegram-typings.svg?style=for-the-badge) ![NPM](https://img.shields.io/npm/l/telegram-typings.svg?style=for-the-badge) ![npm](https://img.shields.io/npm/v/telegram-typings.svg?style=for-the-badge)

This repository contains [Telegram Bot API](https://core.telegram.org/bots/api) typings for [Flow](https://flow.org/), [TypeScript](https://www.typescriptlang.org/) and [Rust](https://www.rust-lang.org/).

The types are automatically generated for all supported languages from the Telegram Bot API website.

## Flow and TypeScript typings

See [javascript/](javascript/) folder.

## Rust typings

See [rust](rust/) folder.

## Contributing

Source code for the type generation lives under [lib/](lib/) folder.

### Setting up local development environment

To contribute to this project, you will need to have the following tools installed:

* Rust

* Node v8.x or higher

* npm v5.7.1 or higher

Once these tools are installed, you can install the required dependencies:

```

npm install

cargo install rustfmt --version 0.9.0

```

### Generating new typings

To generate new types, run the following:

```

npm run build

```

If the [Telegram Bot API](https://core.telegram.org/bots/api) documentation has not changed, and you haven't done any changes to code, you should not get any diff.