docs: update Reply.send() documentation for string serialization#6466
Merged
docs: update Reply.send() documentation for string serialization#6466
Conversation
Fixes #6291 The documentation previously claimed that reply.send(string) would automatically JSON-serialize strings when Content-Type is set to application/json; charset=utf-8. This behavior has never been implemented - strings are sent unmodified by default. Updated the documentation to reflect the actual behavior and added a note showing users how to use .serializer(JSON.stringify) to serialize strings as JSON when needed.
metcoder95
approved these changes
Jan 26, 2026
jsumners
approved these changes
Jan 26, 2026
Member
jsumners
left a comment
There was a problem hiding this comment.
This is appropriate "fix." This specific issue has been on a merry-go-round for years.
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
3 participants
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.
Fixes #6291
Summary
The documentation previously claimed that reply.send(string) would automatically JSON-serialize strings when Content-Type is set to application/json. This behavior has never been implemented - strings are sent unmodified by default.
After discussion with maintainers in the issue, it was decided to update the documentation rather than change the behavior, since this behavior has existed since v2.12.0 (5-6 years) and changing it could be a breaking change.
Changes
This aligns the documentation with the actual behavior and provides users with a clear workaround.