docs: update custom stream SOCKS5 example to modern API (fixes outdated callback usage) #3916
+39
−9
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 updates the “Connecting using custom stream” documentation.
The old example used a callback-style:
stream: function (cb) { ... }
This pattern no longer works in current versions of mysql2 and results in the runtime error:
TypeError: cb is not a function
What changed
Replaced the outdated callback-based SOCKS5 example.
Added a modern example where stream returns a Duplex stream or a Promise that resolves to one.
Added a short note explaining that the callback-style API is no longer supported.
Why this change
The existing docs mislead users into using a deprecated pattern that fails on current mysql2 versions.
The updated version shows the correct API and prevents confusion/errors for anyone connecting over SOCKS5 or other custom transport streams.
Related Issue
Fixes #3655