Skip to content

docs: clarify DUMP/RESTORE binary payload usage#3201

Merged
nkaradzhov merged 1 commit intoredis:masterfrom
nkaradzhov:issue-3193
Mar 20, 2026
Merged

docs: clarify DUMP/RESTORE binary payload usage#3201
nkaradzhov merged 1 commit intoredis:masterfrom
nkaradzhov:issue-3193

Conversation

@nkaradzhov
Copy link
Collaborator

@nkaradzhov nkaradzhov commented Mar 19, 2026

Description

Describe your pull request here


Checklist

  • Does npm test pass with this change (including linting)?
  • Is the new or changed code fully tested?
  • Is a documentation update included (if this change modifies existing APIs, or introduces new ones)?

Note

Low Risk
Documentation-only changes that clarify how to avoid lossy DUMP payload decoding by mapping blob strings to Buffer; no runtime code or behavior changes.

Overview
Updates the main README and packages/redis/README.md to explicitly call out that commands returning serialized binary payloads (notably DUMP) should be used with BLOB_STRING mapped to Buffer before passing results to RESTORE.

Expands docs/command-options.md with a dedicated DUMP/RESTORE section explaining the failure mode when decoding as string, and shows both withTypeMapping and default commandOptions.typeMapping examples (including a note on v5 vs v4 APIs).

Written by Cursor Bugbot for commit daad9c9. This will update automatically on new commits. Configure here.

@nkaradzhov nkaradzhov requested a review from PavelPashov March 19, 2026 17:36
@nkaradzhov nkaradzhov merged commit e75e314 into redis:master Mar 20, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants