Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

add typescript type declarations #60

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

add typescript type declarations #60

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
f4f1589
Added missing parameters to setWebHook method
acran Feb 8, 2019
d6a97e6
Fixed default settings for webhooks and added sanity checks
acran Feb 8, 2019
aa87dc3
Added missing documentation/comments for API params
acran Feb 8, 2019
2a8e33a
Ensure reply_markup is JSON-serialized
acran Feb 8, 2019
9115b00
Added TypeScript type declarations
acran Feb 8, 2019
76a2aae
Added section about TypeScript support to README
acran Feb 8, 2019
b09a7e6
Bugfix: correctly encode request data as JSON body
acran Feb 9, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,20 @@ api.getMe()
});
```

## TypeScript support

This package comes with type declarations included and is ready to be used in TypeScript projects too:

```typescript
import TelegramBotApi from 'telegram-bot-api';

let api = new TelegramBotApi({
token: '<PUT YOUR TOKEN HERE>'
});
```

Supporting editors will then show available autocompletions and type annotations and type check your code.

## Supported methods

For method parameters and description, please refer to official documentation
Expand Down
Loading