Issue # 1697 FIX - creates an example script that shows how to use the SSCAN iterator

examples/README.md

@@ -8,6 +8,7 @@ This folder contains example scripts showing how to use Node Redis in different
 | `blocking-list-pop.js`      | Block until an element is pushed to a list  |
 | `lua-multi-incr.js`         | Define a custom lua script that allows you to perform INCRBY on multiple keys |
 | `command-with-modifiers.js` | Define a script that allows to run a command with several modifiers |
+| `set-scan.js` | An example script that shows how to use the SSCAN iterator functionality  |
 
 ## Contributing
 

examples/set-scan.js

@@ -0,0 +1,19 @@
+// An example script that shows how to use the SSCAN iterator functionality to retrieve the contents of a Redis set.
+// Create the set in redis-cli with this command:
+//     sadd setName a b c d e f g h i j k l m n o p q
+
+import { createClient } from 'redis';
+
+async function setScan() {
+  const client = createClient();
+  await client.connect();
+
+  const setName = 'setName';
+  for await (const member of client.sScanIterator(setName)) {
+    console.log(member);
+  }
+
+  await client.quit();
+}
+
+setScan();