Raw XREAD command fails with "Invalid argument type"

[almosnow]

(Assuming you have a working client and a stream named stream)

When trying to call client.XREAD('STREAMS', 'stream', '0')

the code throws a TypeError: Invalid argument type exception.

I think it's a bug, equivalent redis command is XREAD STREAMS stream 0 and runs without issue through redis-cli.

[leibale]

client.XREAD('STREAMS', {
  key: 'stream',
  id: '0'
})

this should work

[almosnow]

Just tried it out, it doesn't work,

Please note that the raw call to XREAD != xRead.

[leibale]

My bad, this should work (without the STREAMS)

client.XREAD({
  key: 'stream',
  id: '0'
});

[almosnow]

It does work now, thanks!

I thought raw commands had a simple mapping to redis commands like literally [args, arg, arg, arg, ...]

I see that's not the case, is this documented anywhere (how to call each of the raw commands)?

[leibale]

https://redis.js.org/documentation/client/modules/lib_commands_XREAD.html
BTW, the package has full TS support, so you should get autocomplete in your IDE