scan-iterators.md

Scan Iterators

⚠️ The scan iterators API in v5 has breaking changes from the previous version. For more details, refer to the v4-to-v5 guide.

SCAN results can be looped over using async iterators:

for await (const keys of client.scanIterator()) {
  const values = await client.mGet(keys);
}

This works with HSCAN, SSCAN, and ZSCAN too:

for await (const entries of client.hScanIterator('hash')) {}
for await (const members of client.sScanIterator('set')) {}
for await (const membersWithScores of client.zScanIterator('sorted-set')) {}

You can override the default options by providing a configuration object:

client.scanIterator({
  cursor: '0', // optional, defaults to '0'
  TYPE: 'string', // `SCAN` only
  MATCH: 'patter*',
  COUNT: 100
});