fix(deps): update dependency @upstash/redis to v1.34.0 (#713)

.changeset/six-teachers-teach.md

@@ -0,0 +1,5 @@
+---
+"@vercel/kv": major
+---
+
+BREAKING: Updates @upstash/redis to v1.34.0 which contains a small breaking change in the public API. The cursor field in scan commands is now returned as `string` instead of `number`.

packages/kv/src/index.test.ts

@@ -1,6 +1,6 @@
 import defaultKv, { kv, VercelKV, createClient } from '.';
 
-let scanReturnValues: [number, string[]][] = [[0, []]];
+let scanReturnValues: [string, string[]][] = [['0', []]];
 jest.mock('@upstash/redis', () => ({
   Redis: jest.fn(() => ({
     get: jest.fn().mockResolvedValue('bar'),
@@ -14,7 +14,7 @@ jest.mock('@upstash/redis', () => ({
 
 describe('@vercel/kv', () => {
   beforeEach(() => {
-    scanReturnValues = [[0, []]];
+    scanReturnValues = [['0', []]];
     jest.clearAllMocks();
   });
 
@@ -78,9 +78,9 @@ describe('@vercel/kv', () => {
 
     it('supports iteration', async () => {
       scanReturnValues = [
-        [2, ['1', '2']],
-        [4, ['3', '4']],
-        [0, []],
+        ['2', ['1', '2']],
+        ['4', ['3', '4']],
+        ['0', []],
       ];
       const client = createClient({ url: 'foobar', token: 'foobar' });
       const returnedKeys: string[] = [];

packages/kv/src/index.ts

@@ -10,15 +10,15 @@ export class VercelKV extends Redis {
    * Same as `scan` but returns an AsyncIterator to allow iteration via `for await`.
    */
   async *scanIterator(options?: ScanCommandOptions): AsyncIterable<string> {
-    let cursor = 0;
+    let cursor = '0';
     let keys: string[];
     do {
       // eslint-disable-next-line no-await-in-loop -- [@vercel/style-guide@5 migration]
       [cursor, keys] = await this.scan(cursor, options);
       for (const key of keys) {
         yield key;
       }
-    } while (cursor !== 0);
+    } while (cursor !== '0');
   }
 
   /**
@@ -28,15 +28,15 @@ export class VercelKV extends Redis {
     key: string,
     options?: ScanCommandOptions,
   ): AsyncIterable<string | number> {
-    let cursor = 0;
+    let cursor = '0';
     let items: (number | string)[];
     do {
       // eslint-disable-next-line no-await-in-loop -- [@vercel/style-guide@5 migration]
       [cursor, items] = await this.hscan(key, cursor, options);
       for (const item of items) {
         yield item;
       }
-    } while (cursor !== 0);
+    } while (cursor !== '0');
   }
 
   /**
@@ -46,15 +46,15 @@ export class VercelKV extends Redis {
     key: string,
     options?: ScanCommandOptions,
   ): AsyncIterable<string | number> {
-    let cursor = 0;
+    let cursor = '0';
     let items: (number | string)[];
     do {
       // eslint-disable-next-line no-await-in-loop -- [@vercel/style-guide@5 migration]
       [cursor, items] = await this.sscan(key, cursor, options);
       for (const item of items) {
         yield item;
       }
-    } while (cursor !== 0);
+    } while (cursor !== '0');
   }
 
   /**
@@ -64,15 +64,15 @@ export class VercelKV extends Redis {
     key: string,
     options?: ScanCommandOptions,
   ): AsyncIterable<string | number> {
-    let cursor = 0;
+    let cursor = '0';
     let items: (number | string)[];
     do {
       // eslint-disable-next-line no-await-in-loop -- [@vercel/style-guide@5 migration]
       [cursor, items] = await this.zscan(key, cursor, options);
       for (const item of items) {
         yield item;
       }
-    } while (cursor !== 0);
+    } while (cursor !== '0');
   }
 }