Add RBS for [email protected] #243
Merged
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
pocke
reviewed
Oct 19, 2022
gems/jwt/2.5/jwt.rbs
Outdated
|
|
||
| def self?.encode: (untyped payload, untyped key, ::String | _Algo algorithm, ?::Hash[::String | ::Symbol, untyped] header_fields) -> ::String | ||
|
|
||
| def self?.decode: (String jwt, ?untyped? key, ?bool verify, ?::Hash[Symbol, untyped] options) ?{ (Hash[::String, untyped] header, ?untyped payload) -> untyped } -> [untyped, Hash[::String, untyped]] |
There was a problem hiding this comment.
Suggested change
| def self?.decode: (String jwt, ?untyped? key, ?bool verify, ?::Hash[Symbol, untyped] options) ?{ (Hash[::String, untyped] header, ?untyped payload) -> untyped } -> [untyped, Hash[::String, untyped]] | |
| def self?.decode: (String jwt, ?untyped? key, ?boolish verify, ?::Hash[Symbol, untyped] options) ?{ (Hash[::String, untyped] header, ?untyped payload) -> untyped } -> [untyped, Hash[::String, untyped]] |
How about using boolish instead of bool?
https://github.com/ruby/rbs/blob/30e800622a2d7217f822beb2693bdff16f528193/docs/syntax.md#bool-or-boolish
decode method receives anything as verify, and the argument is used only for if/unless conditions. So I think we have no reason to strict it to true or false.
There was a problem hiding this comment.
Thx, you are right. Also return types of _Algo#valid_alg? and _Algo#verify should be boolish.
pocke
reviewed
Oct 19, 2022
gems/jwt/2.5/jwt.rbs
Outdated
| def verify: (data: untyped, signature: ::String, verification_key: untyped) -> bool | ||
| end | ||
|
|
||
| def self?.encode: (untyped payload, untyped key, ::String | _Algo algorithm, ?::Hash[::String | ::Symbol, untyped] header_fields) -> ::String |
There was a problem hiding this comment.
Suggested change
| def self?.encode: (untyped payload, untyped key, ::String | _Algo algorithm, ?::Hash[::String | ::Symbol, untyped] header_fields) -> ::String | |
| def self?.encode: (untyped payload, untyped key, ?::String | _Algo algorithm, ?::Hash[::String | ::Symbol, untyped] header_fields) -> ::String |
algorithm argument looks optional.
https://github.com/jwt/ruby-jwt/blob/b1b52504a7d7819240f2bc9a50da1a79ed03df2b/lib/jwt.rb#L21
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.
This PR add RBS for [email protected].
Currently this RBS contains definition of
JWT.encodeandJWT.decode(incomplete)