Add note in docs for origins(fn) about error needing to be a string.
#2895
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
|
Pull/2895 |
|
Thanks 👍 That behaviour is indeed weird, I'll add it to the list of breaking changes for version 4.0.0 of engine.io. |
This was referenced Jan 10, 2023
dzad
pushed a commit
to dzad/socket.io
that referenced
this pull request
May 29, 2023
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.
The kind of change this PR does introduce
Current behaviour
The docs for
origins(fn)currently don't mention thaterrorhas to be supplied as a string. This really tripped me up as I was supplying an Error instance as I usually do for callbacks, which crashes w/ certain versions of Node.New behaviour
Added line to documentation indicating that
errorshould be a string.Other information (e.g. related issues)
An alternative to this would be to patch
engine.ioto allow an Error instance in its abortConnection method, using itsmessageproperty as the error message.