[v5]spop and sPopCount types are incorrect

[throrin19]

Description

Hi, I think the type returned by functions spop and spopCount are invalid. Actually the type return :

Promise<string | null>

But this functions return an array of string. The return type should be Promise<string[]> instead.

Node.js Version

22.16.0

Redis Server Version

No response

Node Redis Version

5.5.6

Platform

macOS

Logs

[nkaradzhov]

@throrin19 thanks for catching this!

sPop is actually meant to return string | null. There is no issue here. See this snippet from the documentation

By default, the command pops a single member from the set. When provided with the optional count argument, the reply will consist of up to count members, depending on the set's cardinality.

sPopCount is meant to return Array<string> - there is a bug that we are gonna fix.

[throrin19]

@nkaradzhov thanks for your reactivity.

By default, the command pops a single member from the set. When provided with the optional count argument, the reply will consist of up to count members, depending on the set's cardinality.

Actually, types returned by v5 doesn't accept the count argument for spop. I move to sPopCount

[nkaradzhov]

Yes, this is a snippet from the redis docs itself, not from node-redis, sorry for confusion.

redis the server has spop -> string | null | array

in node-redis, we are trying to provide more ergonomy to users, so in this particular case we have two methods:

sPop -> string | null
sPopCount -> array

So, in general, if you want to pop one item, you use sPop and you know that you are gonna receive either a string or null. And if you want to pop more items, you use sPopCount and you know you are gonna receive an array ( could be empy ) of strings

[throrin19]

ok, I understand the change 👍 . Thanks for your response