Clustering sendCommand docs #3053
Merged
Conversation
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
We noticed that `sendCommand()` takes different arguments for clusters vs clients, and I wanted to document the differences. I think I got it correct, but please review closely just to be sure. It might also be worth adding a note to [the readme](https://github.com/redis/node-redis/blob/2f106324507eec905b8fe7691ba11179acdeeca7/README.md#L136-L144) also, since this is a somewhat unexpected difference, what do you think? Relates to express-rate-limit/rate-limit-redis#207 & express-rate-limit/rate-limit-redis#208
nfriedly
commented
Aug 12, 2025
| @@ -38,6 +38,25 @@ await cluster.close(); | |||
| | scripts | | Script definitions (see [Lua Scripts](./programmability.md#lua-scripts)) | | |||
| | functions | | Function definitions (see [Functions](./programmability.md#functions)) | | |||
|
|
|||
| ## Usage | |||
|
|
|||
| Most redis commands are the same as with individual clients. | |||
There was a problem hiding this comment.
I hope this is true. Are there other differences that should be mentioned here?
nkaradzhov
approved these changes
Aug 13, 2025
There was a problem hiding this comment.
Thanks @nfriedly, your comments are spot on. Its nice to have this explained
| @@ -38,6 +38,25 @@ await cluster.close(); | |||
| | scripts | | Script definitions (see [Lua Scripts](./programmability.md#lua-scripts)) | | |||
| | functions | | Function definitions (see [Functions](./programmability.md#functions)) | | |||
|
|
|||
| ## Usage | |||
|
|
|||
| Most redis commands are the same as with individual clients. | |||
nfriedly
added a commit
to nfriedly/node-redis
that referenced
this pull request
Aug 13, 2025
3 tasks
nkaradzhov
pushed a commit
that referenced
this pull request
Aug 14, 2025
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
We noticed that
sendCommand()takes different arguments for clusters vs clients, and I wanted to document the differences. I think I got it correct, but please review closely just to be sure.It might also be worth adding a note to the readme also, since this is a somewhat unexpected difference, what do you think?
Relates to express-rate-limit/rate-limit-redis#207 & express-rate-limit/rate-limit-redis#208
Checklist
npm testpass with this change (including linting)?Is the new or changed code fully tested?(N/A)