@upstash/redis 1.40.0 → 1.41.0

package/docs/commands/string/set.mdx

@@ -0,0 +1,79 @@
+---
+title: SET
+description: Set a key to hold a string value.
+---
+
+## Arguments
+
+<ParamField body="key" type="string" required>
+  The key
+</ParamField>
+
+<ParamField body="value" type="TValue" required>
+  The value, if this is not a string, we will use `JSON.stringify` to convert it
+  to a string.
+</ParamField>
+
+<ParamField body="opts" type="object">
+You can pass a few options to the command.
+<Expandable >
+
+  <ParamField body="get" type="boolean">
+    Instead of returning `"OK"`, this will cause the command to return the old
+    value stored at key, or `null` when key did not exist.
+  </ParamField>
+  <ParamField body="ex" type="integer">
+    Adds an expiration (in seconds) to the key.
+  </ParamField>
+  <ParamField body="px" type="integer">
+    Adds an expiration (in milliseconds) to the key.
+  </ParamField>
+  <ParamField body="exat" type="integer">
+    Expires the key after the given timestamp (in seconds).
+  </ParamField>
+
+  <ParamField body="pxat" type="integer">
+    Expires the key after the given timestamp (in milliseconds).
+  </ParamField>
+
+  <ParamField body="keepTtl" type="boolean">
+    Keeps the old expiration if the key already exists.
+  </ParamField>
+
+  <ParamField body="nx" type="boolean">
+    Only set the key if it does not already exist.
+  </ParamField>
+
+  <ParamField body="xx" type="boolean">
+    Only set the key if it already exists.
+  </ParamField>
+
+  
+
+</Expandable>
+
+</ParamField>
+
+## Response
+
+<ResponseField required>
+  `"OK"`
+</ResponseField>
+
+<RequestExample>
+```ts Basic
+await redis.set("my-key", {my: "value"});
+```
+
+```ts Expire in 60 seconds
+await redis.set("my-key", {my: "value"}, {
+  ex: 60
+});
+```
+
+```ts Only update
+await redis.set("my-key", {my: "value"}, {
+  xx: true
+});
+```
+</RequestExample>

package/docs/commands/string/setrange.mdx

@@ -0,0 +1,38 @@
+---
+title: SETRANGE
+description: Writes the value of key at offset.
+---
+
+The SETRANGE command in Redis is used to modify a portion of the value of a key by replacing a substring within the key's existing value. It allows you to update part of the string value associated with a specific key at a specified offset.
+
+## Arguments
+
+<ParamField body="key" type="string" required>
+The name of the Redis key for which you want to modify the value.
+</ParamField>
+
+<ParamField body="offset" type="integer" required>
+The zero-based index in the value where you want to start replacing characters.
+</ParamField>
+
+<ParamField body="value" type="string" required>
+  The new string that you want to insert at the specified offset in the existing value.
+</ParamField>
+
+  
+## Response
+
+<ResponseField type="integer" required>
+  The length of the value after it was modified.
+</ResponseField>
+
+<RequestExample>
+```ts Example
+await redis.set("key", "helloworld")
+const length = await redis.setrange("key", 5, "redis");
+console.log(length); // 10
+
+// The value of "key" is now "helloredis"
+```
+
+</RequestExample>

package/docs/commands/string/strlen.mdx

@@ -0,0 +1,26 @@
+---
+title: STRLEN
+description: Return the length of a string stored at a key.
+---
+
+The `STRLEN`` command in Redis is used to find the length of the string value associated with a key. In Redis, keys can be associated with various data types, and one of these data types is the "string." The STRLEN command specifically operates on keys that are associated with string values.
+## Arguments
+
+<ParamField body="key" type="string" required>
+The name of the Redis key.
+</ParamField>
+
+## Response
+
+<ResponseField type="integer" required>
+  The length of the value.
+</ResponseField>
+
+<RequestExample>
+```ts Example
+await redis.set("key", "helloworld")
+const length = await redis.strlen("key");
+console.log(length); // 10
+```
+
+</RequestExample>

package/docs/commands/transaction.mdx

@@ -0,0 +1,22 @@
+---
+title: Transactions
+description: Transactions
+---
+
+You can use transactions or pipelines with the `multi` or `pipeline` method.
+
+Transactions are executed atomically, while pipelines are not. In pipelines you can execute multiple commands at once, but other commands from other clients can be executed in between.
+
+<CodeGroup>
+
+```ts Transaction
+const tx = redis.multi();
+tx.set("foo", "bar");
+tx.get("foo");
+const res = await tx.exec();
+```
+
+</CodeGroup>
+
+For more information on pipelines and transactions, see
+[the Pipeline page](https://docs.upstash.com/redis/sdks/ts/pipelining/pipeline-transaction).

package/docs/commands/zset/zadd.mdx

@@ -0,0 +1,102 @@
+---
+title: ZADD
+description: Add a member to a sorted set, or update its score if it already exists.
+---
+
+
+## Arguments 
+
+<ParamField body="key" type="string" required>
+  The key of the sorted set.
+</ParamField>
+
+<ParamField body="options">
+    <ParamField body="xx" type="boolean">
+        Only update elements that already exist. Never add elements.
+    </ParamField>
+    <ParamField body="nx" type="boolean">
+        Only add new elements. Never update elements.
+    </ParamField>
+    <ParamField body="ch" type="boolean">
+        Return the number of elements added or updated.
+    </ParamField>
+    <ParamField body="incr" type="boolean">
+        When this option is specified ZADD acts like ZINCRBY. Only one score-element pair can be specified in this mode.
+    </ParamField>
+    <ParamField body="gt" type="boolean">
+        Only update existing elements if the new score is greater than the current score. Add element without a check if it does not exist.
+    </ParamField>
+    <ParamField body="lt" type="boolean">
+        Only update existing elements if the new score is less than the current score. Add element without a check if it does not exist.
+    </ParamField>
+</ParamField>
+
+## Response
+
+<ResponseField type="integer"  required>
+    The number of elements added to the sorted sets, not including elements already existing for which the score was updated.
+
+    If `ch` was specified, the number of elements that were updated.
+
+    If `incr` was specified, the new score of `member`.
+</ResponseField>
+
+
+
+<RequestExample>
+```ts Simple
+await redis.zadd(
+    "key", 
+    { score: 2, member: "member" }, 
+    { score: 3, member: "member2"},
+);
+```
+
+```ts XX 
+await redis.zadd(
+    "key",
+    { xx: true },
+    { score: 2, member: "member" },
+)
+```
+
+```ts NX 
+await redis.zadd(
+    "key",
+    { nx: true },
+    { score: 2, member: "member" },
+)
+```
+
+```ts CH 
+await redis.zadd(
+    "key",
+    { ch: true },
+    { score: 2, member: "member" },
+)
+```
+
+```ts INCR 
+await redis.zadd(
+    "key",
+    { cincrh: true },
+    { score: 2, member: "member" },
+)
+```
+
+```ts GT
+await redis.zadd(
+    "key",
+    { gt: true },
+    { score: 2, member: "member" },
+)
+```
+
+```ts LT
+await redis.zadd(
+    "key",
+    { lt: true },
+    { score: 2, member: "member" },
+)
+```
+</RequestExample>

package/docs/commands/zset/zcard.mdx

@@ -0,0 +1,31 @@
+---
+title: ZCARD
+description: Returns the number of elements in the sorted set stored at key.
+---
+
+
+## Arguments 
+
+<ParamField body="key" type="string" required>
+  The key to get.
+</ParamField>
+
+## Response
+
+<ResponseField type="integer" required>
+    The number of elements in the sorted set.
+</ResponseField>
+
+
+
+<RequestExample>
+```ts Example
+
+await redis.zadd("key", 
+    { score: 1, member: "one"}, 
+    { score: 2, member: "two" },
+);
+const elements = await redis.zcard("key");
+console.log(elements); // 2
+```
+</RequestExample>

package/docs/commands/zset/zcount.mdx

@@ -0,0 +1,47 @@
+---
+title: ZCOUNT
+description: Returns the number of elements in the sorted set stored at key filterd by score.
+---
+
+
+## Arguments 
+
+<ParamField body="key" type="string" required>
+  The key to get.
+</ParamField>
+
+<ParamField body="min" type="integer | string" required>
+    The minimum score to filter by.
+
+    Use `-inf` to effectively ignore this filter.
+
+    Use `(number` to exclude the value.
+</ParamField>
+
+
+<ParamField body="max" type="integer | string" required>
+    The maximum score to filter by.
+
+    Use `+inf` to effectively ignore this filter.
+
+     Use `(number` to exclude the value.
+</ParamField>
+
+## Response
+
+<ResponseField type="integer" required>
+    The number of elements where score is between min and max.
+</ResponseField>
+
+
+
+<RequestExample>
+```ts Example
+await redis.zadd("key", 
+    { score: 1, member: "one"}, 
+    { score: 2, member: "two" },
+);
+const elements = await redis.zcount("key", "(1", "+inf");
+console.log(elements); // 1
+```
+</RequestExample>

package/docs/commands/zset/zdiffstore.mdx

@@ -0,0 +1,33 @@
+---
+title: ZDIFFSTORE
+description: Writes the difference between sets to a new key.
+---
+
+
+## Arguments 
+
+<ParamField body="destination" type="string" required>
+  The key to write the difference to.
+</ParamField>
+
+<ParamField body="keys" type="integer" required>
+  How many keys to compare.
+</ParamField>
+
+<ParamField body="keys" type="...string[]" required>
+  The keys to compare.
+</ParamField>
+
+## Response
+
+<ResponseField  required>
+    The number of elements in the resulting set.
+</ResponseField>
+
+
+
+<RequestExample>
+```ts Example
+const values = await redis.zdiffstore("destination", 2, "key1", "key2");
+```
+</RequestExample>

package/docs/commands/zset/zincrby.mdx

@@ -0,0 +1,37 @@
+---
+title: ZINCRBY
+description: Increment the score of a member.
+---
+
+
+## Arguments 
+
+<ParamField body="key" type="string" required>
+  The key of the sorted set.
+</ParamField>
+
+<ParamField body="increment" type="integer" required>
+    The increment to add to the score.
+</ParamField>
+
+
+<ParamField body="member" type="TMember" required>
+  The member to increment.
+</ParamField>
+
+
+## Response
+
+<ResponseField type="integer" required>
+    The new score of `member` after the increment operation.
+</ResponseField>
+
+
+
+<RequestExample>
+```ts Example
+await redis.zadd("key", 1, "member");
+const value = await redis.zincrby("key", 2, "member");
+console.log(value); // 3
+```
+</RequestExample>

package/docs/commands/zset/zinterstore.mdx

@@ -0,0 +1,98 @@
+---
+title: ZINTERSTORE
+description: Writes the intersection between sets to a new key.
+---
+
+
+## Arguments 
+
+<ParamField body="destination" type="string" required>
+  The key to write the intersection to.
+</ParamField>
+
+<ParamField body="keys" type="integer" required>
+  How many keys to compare.
+</ParamField>
+
+<ParamField body="keys" type="string | string[]" required>
+  The keys to compare.
+</ParamField>
+
+<ParamField body="options">
+    <ParamField body="aggregate" type="sum | min | max">
+        The aggregation method.
+    </ParamField>
+
+    <ParamField body="weight" type="number">
+        The weight to apply to each key.
+    </ParamField>
+    
+    <ParamField body="weights" type="number[]">
+        The weights to apply to each key.
+    </ParamField>
+    
+</ParamField>
+
+## Response
+
+<ResponseField  required>
+    The number of elements in the resulting set.
+</ResponseField>
+
+
+
+<RequestExample>
+```ts Simple
+await redis.zadd(
+    "key1", 
+    { score: 1, member: "member1" },
+)
+await redis.zadd(
+    "key2",
+    { score: 1, member: "member1" },
+    { score: 2, member: "member2" },
+)
+
+const res = await redis.zinterstore("destination", 2, ["key1", "key2"]);
+console.log(res) // 1
+```
+
+```ts With Weights
+await redis.zadd(
+    "key1", 
+    { score: 1, member: "member1" },
+)
+await redis.zadd(
+    "key2",
+    { score: 1, member: "member1" },
+    { score: 2, member: "member2" },
+)
+const res = await redis.zinterstore(
+    "destination",
+    2,
+    ["key1", "key2"],
+    { weights: [2, 3] },
+);
+console.log(res) // 1
+```
+
+
+```ts Aggregate
+await redis.zadd(
+    "key1", 
+    { score: 1, member: "member1" },
+)
+await redis.zadd(
+    "key2",
+    { score: 1, member: "member1" },
+    { score: 2, member: "member2" },
+)
+const res = await redis.zinterstore(
+    "destination",
+    2,
+    ["key1", "key2"],
+    { aggregate: "sum" },
+);
+console.log(res) // 1
+```
+</RequestExample>

package/docs/commands/zset/zlexcount.mdx

@@ -0,0 +1,43 @@
+---
+title: ZLEXCOUNT
+description: Returns the number of elements in the sorted set stored at key filtered by lex.
+---
+
+
+## Arguments
+
+<ParamField body="key" type="string" required>
+  The key to get.
+</ParamField>
+
+<ParamField body="min" type="string" required>
+    The lower lexicographical bound to filter by.
+
+    Use `-` to disable the lower bound.
+</ParamField>
+
+
+<ParamField body="max" type="string" required>
+    The upper lexicographical bound to filter by.
+
+    Use `+` to disable the upper bound.
+</ParamField>
+
+## Response
+
+<ResponseField type="integer" required>
+    The number of matched.
+</ResponseField>
+
+
+
+<RequestExample>
+```ts Example
+await redis.zadd("key", 
+    { score: 1, member: "one"}, 
+    { score: 2, member: "two" },
+);
+const elements = await redis.zlexcount("key", "two", "+");
+console.log(elements); // 1
+```
+</RequestExample>

package/docs/commands/zset/zmscore.mdx

@@ -0,0 +1,34 @@
+---
+title: ZMSCORE
+description: Returns the scores of multiple members.
+---
+
+
+## Arguments 
+
+<ParamField body="key" type="string" required>
+  The key to get.
+</ParamField>
+
+## Response
+
+<ResponseField body="members" type="TMember[]" required>
+    The members of the sorted set.
+</ResponseField>
+
+
+
+<RequestExample>
+```ts Example
+
+await redis.zadd("key", 
+    { score: 1, member: "m1" },
+    { score: 2, member: "m2" },
+    { score: 3, member: "m3" },
+    { score: 4, member: "m4" },
+)
+
+const scores = await redis.zmscore("key", ["m2", "m4"])
+console.log(scores) // [2, 4]
+```
+</RequestExample>

package/docs/commands/zset/zpopmax.mdx

@@ -0,0 +1,25 @@
+---
+title: ZPOPMAX
+description: Removes and returns up to count members with the highest scores in the sorted set stored at key.
+---
+
+
+## Arguments 
+
+<ParamField body="key" type="string" required>
+  The key of the sorted set
+</ParamField>
+
+## Response
+
+<ResponseField body="count" type="integer">
+    The number of elements removed. Defaults to 1.
+</ResponseField>
+
+
+
+<RequestExample>
+```ts Example
+const popped = await redis.zpopmax("key", 4);
+```
+</RequestExample>

package/docs/commands/zset/zpopmin.mdx

@@ -0,0 +1,25 @@
+---
+title: ZPOPMIN
+description: Removes and returns up to count members with the lowest scores in the sorted set stored at key.
+---
+
+
+## Arguments 
+
+<ParamField body="key" type="string" required>
+  The key of the sorted set
+</ParamField>
+
+## Response
+
+<ResponseField body="count" type="integer">
+    The number of elements removed. Defaults to 1.
+</ResponseField>
+
+
+
+<RequestExample>
+```ts Example
+const popped = await redis.zpopmin("key", 4);
+```
+</RequestExample>