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.

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

Add section in docs about TypeScript #1121

Merged
merged 4 commits into from
Sep 3, 2020
Merged

Add section in docs about TypeScript #1121

merged 4 commits into from
Sep 3, 2020

Conversation

KnorpelSenf
Copy link
Collaborator

Description

Adds a section to the docs about some caveats when using the project with TypeScript.

Should perhaps only be merged after #1074 because technically there are still some parts in JS.

Fixes #914

Type of change

Please delete options that are not relevant.

  • Documentation (typos, code examples or any documentation update)

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation

Copy link
Member

@wojpawlik wojpawlik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good addition. This should be near the Extending context paragraph tho.

Also, I was recently permitted to introduce breaking changes, so it's a perfect time to try to make it less necessary to extend context by hand. session can be correctly typed as Middleware.ExtFn, and Composer::use can be overloaded to pick it up.

docs/README.md Outdated Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
Co-authored-by: Wojciech Pawlik <woj.pawlik@gmail.com>
docs/README.md Outdated Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
Co-authored-by: Wojciech Pawlik <woj.pawlik@gmail.com>
@wojpawlik wojpawlik merged commit 3e1373f into telegraf:develop Sep 3, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ContextMessageUpdate type definition missing 'session'
2 participants