Avoid misleading error message in HTTP::Params.encode #5184
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
Restrict types supported by HTTP::Params.encode to avoid long and confusing
error messages.
With this change, attempt to use a `Hash` other than `Hash(String, String)`
will result in a better error message:
require "http/params"
puts HTTP::Params.encode({"foo" => 10})
Output:
no overload matches 'HTTP::Params.encode' with type Hash(String, Int32)
Overloads are:
- HTTP::Params.encode(hash : Hash(String, String))
- HTTP::Params.encode(named_tuple : NamedTuple)
Also includes examples on usage.
Fixes #5172
RX14
approved these changes
Oct 26, 2017
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.
Restrict types supported by
HTTP::Params.encodeto avoid long and confusing error messages.With this change, attempt to use a
Hashother thanHash(String, String)will result in a better error message:Output:
Also includes examples on usage.
Fixes #5172
Thank you.
❤️ ❤️ ❤️