Fix #1240 by enabling to pass integer as post_at in chat.scheduleMessage API calls #1242
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…duleMessage API calls
seratch
added
bug
17 tasks
misscoded
reviewed
May 20, 2021
| @@ -1225,7 +1225,7 @@ export interface ChatPostMessageArguments extends WebAPICallOptions, TokenOverri | |||
| export interface ChatScheduleMessageArguments extends WebAPICallOptions, TokenOverridable { | |||
| channel: string; | |||
| text?: string; | |||
| post_at: string; | |||
| post_at: string | number; | |||
There was a problem hiding this comment.
One thought: by not limiting it to only number, there's a greater possibility that folks will continue to interpret string as possibly being a timestamp, as the dev in this case did. By switching it to number, we reduce the chance of that happening.
There was a problem hiding this comment.
@misscoded As I mentioned in this PR's description and my response to the developer, using string here is totally fine. It works. The issue the developer had was that they used non-integer value. For this reason, we still can have string as an acceptable type for it. If we remove string from here, it's a breaking change.
|
Thanks for your reviews! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
This pull request fixes #1240 by correcting the argument type for
post_atinChatScheduleMessageArguments. The argument should accept eithernumber(specifically integer value) orstringvalue for it. Although bothnumberandstringactually works, the API document https://api.slack.com/methods/chat.scheduleMessage recommendsnumberoverstring.Requirements (place an
xin each[ ])