docs: clarify DUMP/RESTORE binary payload usage#3201
Merged
nkaradzhov merged 1 commit intoredis:masterfrom Mar 20, 2026
Merged
Conversation
PavelPashov
approved these changes
Mar 20, 2026
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.
Description
Checklist
npm testpass with this change (including linting)?Note
Low Risk
Documentation-only changes that clarify how to avoid lossy
DUMPpayload decoding by mapping blob strings toBuffer; no runtime code or behavior changes.Overview
Updates the main README and
packages/redis/README.mdto explicitly call out that commands returning serialized binary payloads (notablyDUMP) should be used withBLOB_STRINGmapped toBufferbefore passing results toRESTORE.Expands
docs/command-options.mdwith a dedicatedDUMP/RESTOREsection explaining the failure mode when decoding asstring, and shows bothwithTypeMappingand defaultcommandOptions.typeMappingexamples (including a note on v5 vs v4 APIs).Written by Cursor Bugbot for commit daad9c9. This will update automatically on new commits. Configure here.