fix: Payload encoding example with binary - #48
Merged
Conversation
Signed-off-by: eXhumer <exhumer@exhumer.cc>
Member
|
@eXhumer good catch, thanks a lot 👍 |
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
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.
I noticed that only the protocol 4 had typing support and I wanted to implement the protocol 3 client myself with typescript and was testing all things needed for a fully featured protocol 3 client. During this time, I noticed that the example of the payload with binary message, with binary output, is incorrectly documented as it is missing the type byte in the Buffer output. Running the example with
engine.io-parser@2.2.1(last supported parser for protocol 3) to test the actual output.On the console, the following gets printed
In the protocol document, the example shows an output of
This commit aims to fix this discrepancy in the example.