@upstash/redis 1.6.1-next.1 → 1.7.1-next.1

package/README.md

@@ -11,9 +11,9 @@ It is the only connectionless (HTTP based) Redis client and designed for:
 
 - Serverless functions (AWS Lambda ...)
 - Cloudflare Workers (see
-  [the example](https://github.com/upstash/upstash-redis/tree/master/examples/cloudflare-workers))
+  [the example](https://github.com/upstash/upstash-redis/tree/main/examples/cloudflare-workers))
 - Fastly Compute@Edge (see
-  [the example](https://github.com/upstash/upstash-redis/tree/master/examples/fastly))
+  [the example](https://github.com/upstash/upstash-redis/tree/main/examples/fastly))
 - Next.js, Jamstack ...
 - Client side web/mobile applications
 - WebAssembly
@@ -23,11 +23,86 @@ See
 [the list of APIs](https://docs.upstash.com/features/restapi#rest---redis-api-compatibility)
 supported.
 
+## Quick Start
+
+### Install
+
+#### npm
+
+```bash
+npm install @upstash/redis
+```
+
+#### Deno
+
+```ts
+import { Redis } from "https://deno.land/x/upstash_redis/mod.ts";
+```
+
+### Create database
+
+Create a new redis database on [upstash](https://console.upstash.com/)
+
+## Basic Usage:
+
+```ts
+import { Redis } from "@upstash/redis"
+
+const redis = new Redis({
+  url: <UPSTASH_REDIS_REST_URL>,
+  token: <UPSTASH_REDIS_REST_TOKEN>,
+})
+
+// string
+await redis.set('key', 'value');
+let data = await redis.get('key');
+console.log(data)
+
+await redis.set('key2', 'value2', {ex: 1});
+
+// sorted set
+await redis.zadd('scores', { score: 1, member: 'team1' })
+data = await redis.zrange('scores', 0, 100 )
+console.log(data)
+
+// list
+await redis.lpush('elements', 'magnesium')
+data = await redis.lrange('elements', 0, 100 )
+console.log(data)
+
+// hash
+await redis.hset('people', {name: 'joe'})
+data = await redis.hget('people', 'name' )
+console.log(data)
+
+// sets
+await redis.sadd('animals', 'cat')
+data  = await redis.spop('animals', 1)
+console.log(data)
+```
+
+### Upgrading to v1.4.0 **(ReferenceError: fetch is not defined)**
+
+If you are running on nodejs v17 and earlier, `fetch` will not be natively
+supported. Platforms like Vercel, Netlify, Deno, Fastly etc. provide a polyfill
+for you. But if you are running on bare node, you need to either specify a
+polyfill yourself or change the import path to:
+
+```typescript
+import { Redis } from "@upstash/redis/with-fetch";
+```
+
+### Upgrading from v0.2.0?
+
+Please read the
+[migration guide](https://docs.upstash.com/redis/sdks/javascriptsdk/migration).
+For further explanation we wrote a
+[blog post](https://blog.upstash.com/upstash-redis-sdk-v1).
+
 ## Docs
 
-See
-[the documentation](https://docs.upstash.com/redis/sdks/javascriptsdk/getstarted)
-for details.
+See [the documentation](https://docs.upstash.com/features/javascriptsdk) for
+details.
 
 ## Contributing
 

package/esm/pkg/commands/zrange.js

@@ -12,6 +12,12 @@ export class ZRangeCommand extends Command {
         if (opts?.byLex) {
             command.push("bylex");
         }
+        if (opts?.rev) {
+            command.push("rev");
+        }
+        if (typeof opts?.count !== "undefined" && typeof opts?.offset !== "undefined") {
+            command.push("limit", opts.offset, opts.count);
+        }
         if (opts?.withScores) {
             command.push("withscores");
         }

package/package.json

@@ -97,5 +97,5 @@
       "types": "./types/platforms/node_with_fetch.d.ts"
     }
   },
-  "version": "1.6.1-next.1"
+  "version": "1.7.1-next.1"
 }

package/script/pkg/commands/zrange.js

@@ -15,6 +15,12 @@ class ZRangeCommand extends command_js_1.Command {
         if (opts?.byLex) {
             command.push("bylex");
         }
+        if (opts?.rev) {
+            command.push("rev");
+        }
+        if (typeof opts?.count !== "undefined" && typeof opts?.offset !== "undefined") {
+            command.push("limit", opts.offset, opts.count);
+        }
         if (opts?.withScores) {
             command.push("withscores");
         }

package/types/pkg/commands/bitpos.d.ts

@@ -3,5 +3,5 @@ import { Command, CommandOptions } from "./command.js";
  * @see https://redis.io/commands/bitpos
  */
 export declare class BitPosCommand extends Command<number, number> {
-    constructor(cmd: [key: string, start: number, end: number], opts?: CommandOptions<number, number>);
+    constructor(cmd: [key: string, bit: 0 | 1, start?: number, end?: number], opts?: CommandOptions<number, number>);
 }

package/types/pkg/commands/lpop.d.ts

@@ -3,5 +3,5 @@ import { Command, CommandOptions } from "./command.js";
  * @see https://redis.io/commands/lpop
  */
 export declare class LPopCommand<TData = string> extends Command<unknown | null, TData | null> {
-    constructor(cmd: [key: string], opts?: CommandOptions<unknown | null, TData | null>);
+    constructor(cmd: [key: string, count?: number], opts?: CommandOptions<unknown | null, TData | null>);
 }

package/types/pkg/commands/rpop.d.ts

@@ -2,6 +2,6 @@ import { Command, CommandOptions } from "./command.js";
 /**
  * @see https://redis.io/commands/rpop
  */
-export declare class RPopCommand<TData = string> extends Command<unknown | null, TData | null> {
-    constructor(cmd: [key: string], opts?: CommandOptions<unknown | null, TData | null>);
+export declare class RPopCommand<TData extends unknown | unknown[] = string> extends Command<unknown | null, TData | null> {
+    constructor(cmd: [key: string, count?: number], opts?: CommandOptions<unknown | null, TData | null>);
 }

package/types/pkg/commands/zrange.d.ts

@@ -1,6 +1,7 @@
 import { Command, CommandOptions } from "./command.js";
 export declare type ZRangeCommandOptions = {
     withScores?: boolean;
+    rev?: boolean;
 } & ({
     byScore: true;
     byLex?: never;
@@ -10,6 +11,12 @@ export declare type ZRangeCommandOptions = {
 } | {
     byScore?: never;
     byLex?: never;
+}) & ({
+    offset: number;
+    count: number;
+} | {
+    offset?: never;
+    count?: never;
 });
 /**
  * @see https://redis.io/commands/zrange

package/types/pkg/pipeline.d.ts

@@ -79,7 +79,7 @@ export declare class Pipeline {
     /**
      * @see https://redis.io/commands/bitpos
      */
-    bitpos: (key: string, start: number, end: number) => this;
+    bitpos: (key: string, bit: 0 | 1, start?: number | undefined, end?: number | undefined) => this;
     /**
      * @see https://redis.io/commands/dbsize
      */
@@ -241,7 +241,7 @@ export declare class Pipeline {
     /**
      * @see https://redis.io/commands/lpop
      */
-    lpop: <TData>(key: string) => this;
+    lpop: <TData>(key: string, count?: number | undefined) => this;
     /**
      * @see https://redis.io/commands/lpush
      */
@@ -325,7 +325,7 @@ export declare class Pipeline {
     /**
      * @see https://redis.io/commands/rpop
      */
-    rpop: <TData = string>(key: string) => this;
+    rpop: <TData = string>(key: string, count?: number | undefined) => this;
     /**
      * @see https://redis.io/commands/rpush
      */

package/types/pkg/redis.d.ts

@@ -52,7 +52,7 @@ export declare class Redis {
     /**
      * @see https://redis.io/commands/bitpos
      */
-    bitpos: (key: string, start: number, end: number) => Promise<number>;
+    bitpos: (key: string, bit: 0 | 1, start?: number | undefined, end?: number | undefined) => Promise<number>;
     /**
      * @see https://redis.io/commands/dbsize
      */
@@ -214,7 +214,7 @@ export declare class Redis {
     /**
      * @see https://redis.io/commands/lpop
      */
-    lpop: <TData>(key: string) => Promise<TData | null>;
+    lpop: <TData>(key: string, count?: number | undefined) => Promise<TData | null>;
     /**
      * @see https://redis.io/commands/lpush
      */
@@ -298,7 +298,7 @@ export declare class Redis {
     /**
      * @see https://redis.io/commands/rpop
      */
-    rpop: <TData = string>(key: string) => Promise<TData | null>;
+    rpop: <TData = string>(key: string, count?: number | undefined) => Promise<TData | null>;
     /**
      * @see https://redis.io/commands/rpush
      */