fix(event): support both positional and object args in parse()#172
Open
mateussiqueira wants to merge 1 commit into
Open
fix(event): support both positional and object args in parse()#172mateussiqueira wants to merge 1 commit into
mateussiqueira wants to merge 1 commit into
Conversation
The parse() function only accepted a single object parameter via
destructuring:
parse({content, signature, user})
But its JSDoc documents positional parameters:
parse(content, signature, user)
When users follow the docs and call parse(content, signature),
destructuring the content string yields undefined for all values,
causing JSON.parse(undefined) → 'Unexpected token u in JSON at position 0'.
Add a compatibility check at the top of the function: if the first
argument is a plain object, use destructuring; otherwise treat them
as positional. Also add input validation so undefined/null content
or signature throws a clear error instead of a cryptic JSON syntax error.
Fixes starkbank#163
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Bug
event.parse()only accepted a single object parameter via destructuring:But the JSDoc documents positional parameters:
When users follow the docs and call
parse(content, signature), destructuring the content string yieldsundefinedfor all values, causingJSON.parse(undefined)→SyntaxError: Unexpected token u in JSON at position 0.Fix
Closes #163