make typing for attach and log functions correct #2238
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🤔 What's changed?
Make the typings for
this.attach
more accurate by providing overload definitions. Also correct thethis.log
type as it can never yield a promise.Included
tsd
test that would fail without these changes.⚡️ What's your motivation?
Fixes #2143 re the ambiguity of whether or not to expect a promise for stream attachments (depends on whether you pass in a callback), but it also improves the type safety around
mediaType
which is really only optional for string attachments.🏷️ What kind of change is this?
📋 Checklist:
This text was originally generated from a template, then edited by hand. You can modify the template here.