@upstash/redis 1.40.0 → 1.41.0

package/docs/commands/pubsub/psubscribe.mdx

@@ -0,0 +1,36 @@
+---
+title: PSUBSCRIBE
+description: Subscribe to a channel by patterns/wildcards
+---
+
+
+## Arguments
+
+<ParamField body="patterns" type="string | string[]" required>
+The patterns matching channels to publish to.
+</ParamField>
+
+## Response
+
+<ResponseField type="Subscriber" required>
+  A subscriber instance which can subscribe to channels.
+</ResponseField>
+
+<RequestExample>
+```ts Example
+const subscription = redis.psubscribe(["user:*"]);
+
+const messages = [];
+subscription.on("pmessage", (data) => {
+  messages.push(data.message);
+});
+
+await redis.publish("user:123", "user:123 message"); // receives
+await redis.publish("user:456", "user:456 message"); // receives
+await redis.publish("other:789", "other:789 message"); // doesn't receive
+
+console.log(messages[0]) // user:123 message
+console.log(messages[1]) // user:456 message
+console.log(messages[2]) // undefined
+```
+</RequestExample>

package/docs/commands/pubsub/publish.mdx

@@ -0,0 +1,27 @@
+---
+title: PUBLISH
+description: Publish a message to a channel
+---
+
+
+## Arguments
+
+<ParamField body="channel" type="string" required>
+The channel to publish to.
+</ParamField>
+
+<ParamField body="message" type="TMessage">
+The message to publish.
+</ParamField>
+
+## Response
+
+<ResponseField type="integer" required>
+  The number of clients who received the message.
+</ResponseField>
+
+<RequestExample>
+```ts Example
+const listeners = await redis.publish("my-channel", "my-message");
+```
+</RequestExample>

package/docs/commands/pubsub/subscribe.mdx

@@ -0,0 +1,28 @@
+---
+title: SUBSCRIBE
+description: Subscribe to a channel
+---
+
+
+## Arguments
+
+<ParamField body="channels" type="string | string[]" required>
+The channel to publish to.
+</ParamField>
+
+## Response
+
+<ResponseField type="Subscriber" required>
+  A subscriber instance which can subscribe to channels.
+</ResponseField>
+
+<RequestExample>
+```ts Example
+const subscription = redis.subscribe(["my-channel"]);
+
+const messages = [];
+subscription.on("message", (data) => {
+  messages.push(data.message);
+});
+```
+</RequestExample>

package/docs/commands/scripts/eval.mdx

@@ -0,0 +1,36 @@
+---
+title: EVAL
+description: Evaluate a Lua script server side.
+---
+
+## Arguments
+
+<ParamField body="script" type="string" required>
+  The lua script to run.
+</ParamField>
+
+<ParamField body="keys" type="string[]" required>
+  All of the keys accessed in the script
+</ParamField>
+
+<ParamField body="args" type="unknown[]" required>
+  All of the arguments you passed to the script
+</ParamField>
+
+## Response
+
+<ResponseField type="any" required>
+  The result of the script.
+</ResponseField>
+
+<RequestExample>
+```ts Example
+const script = `
+    return ARGV[1]
+`
+const result = await redis.eval(script, [], ["hello"]);
+console.log(result) // "hello"
+
+```
+</RequestExample>
+

package/docs/commands/scripts/eval_ro.mdx

@@ -0,0 +1,36 @@
+---
+title: EVAL_RO
+description: Evaluate a read-only Lua script server side.
+---
+
+## Arguments
+
+<ParamField body="script" type="string" required>
+  The read-only lua script to run.
+</ParamField>
+
+<ParamField body="keys" type="string[]" required>
+  All of the keys accessed in the script
+</ParamField>
+
+<ParamField body="args" type="unknown[]" required>
+  All of the arguments you passed to the script
+</ParamField>
+
+## Response
+
+<ResponseField type="any" required>
+  The result of the script.
+</ResponseField>
+
+<RequestExample>
+```ts Example
+const script = `
+    return ARGV[1]
+`
+const result = await redis.evalRo(script, [], ["hello"]);
+console.log(result) // "hello"
+
+```
+</RequestExample>
+

package/docs/commands/scripts/evalsha.mdx

@@ -0,0 +1,36 @@
+---
+title: EVALSHA
+description: Evaluate a cached Lua script server side.
+---
+
+`EVALSHA` is like `EVAL` but instead of sending the script over the wire every time, you reference the script by its SHA1 hash. This is useful for caching scripts on the server side. 
+
+## Arguments
+
+<ParamField body="sha" type="string" required>
+  The sha1 hash of the script.
+</ParamField>
+
+<ParamField body="keys" type="string[]" required>
+  All of the keys accessed in the script
+</ParamField>
+
+<ParamField body="args" type="unknown[]" required>
+  All of the arguments you passed to the script
+</ParamField>
+
+## Response
+
+<ResponseField type="?" required>
+  The result of the script.
+</ResponseField>
+
+<RequestExample>
+```ts Example
+
+const result = await redis.evalsha("fb67a0c03b48ddbf8b4c9b011e779563bdbc28cb", [], ["hello"]);
+console.log(result) // "hello"
+
+```
+</RequestExample>
+

package/docs/commands/scripts/evalsha_ro.mdx

@@ -0,0 +1,36 @@
+---
+title: EVALSHA_RO
+description: Evaluate a cached read-only Lua script server side.
+---
+
+`EVALSHA_RO` is like `EVAL_RO` but instead of sending the script over the wire every time, you reference the script by its SHA1 hash. This is useful for caching scripts on the server side. 
+
+## Arguments
+
+<ParamField body="sha" type="string" required>
+  The sha1 hash of the read-only script.
+</ParamField>
+
+<ParamField body="keys" type="string[]" required>
+  All of the keys accessed in the script
+</ParamField>
+
+<ParamField body="args" type="unknown[]" required>
+  All of the arguments you passed to the script
+</ParamField>
+
+## Response
+
+<ResponseField type="?" required>
+  The result of the script.
+</ResponseField>
+
+<RequestExample>
+```ts Example
+
+const result = await redis.evalshaRo("fb67a0c03b48ddbf8b4c9b011e779563bdbc28cb", [], ["hello"]);
+console.log(result) // "hello"
+
+```
+</RequestExample>
+

package/docs/commands/scripts/script_exists.mdx

@@ -0,0 +1,26 @@
+---
+title: SCRIPT EXISTS
+description: Check if scripts exist in the script cache.
+---
+
+## Arguments
+
+<ParamField body="hashes" type="string[]" required>
+  The sha1 of the scripts to check.
+</ParamField>
+
+## Response
+
+<ResponseField type="number[]" required>
+  An array of numbers. `1` if the script exists, otherwise `0`.
+</ResponseField>
+
+<RequestExample>
+```ts Example
+await redis.scriptExists("<sha1>", "<sha2>")
+
+// Returns 1 
+// [1, 0]
+```
+</RequestExample>
+

package/docs/commands/scripts/script_flush.mdx

@@ -0,0 +1,28 @@
+---
+title: SCRIPT FLUSH
+description: Removes all scripts from the script cache.
+---
+
+## Arguments
+
+<ParamField body="options" type="Object">
+  <ParamField body="async" type="boolean">
+    Performs the flush asynchronously.
+  </ParamField>
+  <ParamField body="sync" type="boolean">
+    Performs the flush synchronously.
+  </ParamField>
+</ParamField>
+
+<RequestExample>
+```ts Example
+await redis.scriptFlush();
+```
+
+```ts With options
+await redis.scriptFlush({
+  async: true,
+});
+```
+</RequestExample>
+

package/docs/commands/scripts/script_load.mdx

@@ -0,0 +1,28 @@
+---
+title: SCRIPT LOAD
+description: Load the specified Lua script into the script cache.
+---
+
+## Arguments
+
+<ParamField body="script" type="string" required>
+  The script to load.
+</ParamField>
+
+## Response
+
+<ResponseField type="string" required>
+  The sha1 of the script.
+</ResponseField>
+
+<RequestExample>
+```ts Example
+const script = `
+  local value = redis.call('GET', KEYS[1])
+  return value
+`;
+const sha1 = await redis.scriptLoad(script);
+
+```
+</RequestExample>
+

package/docs/commands/server/dbsize.mdx

@@ -0,0 +1,22 @@
+---
+title: DBSIZE
+description: Count the number of keys in the database.
+---
+
+
+## Arguments
+
+This command has no arguments
+
+## Response
+
+<ResponseField type="integer" required>
+ The number of keys in the database
+</ResponseField>
+
+<RequestExample>
+```ts Example
+const keys = await redis.dbsize();
+console.log(keys) // 20
+```
+</RequestExample>

package/docs/commands/server/flushall.mdx

@@ -0,0 +1,25 @@
+---
+title: FLUSHALL
+---
+
+
+<Warning>
+Deletes all keys permanently. Use with caution!
+</Warning>
+## Arguments
+
+<ParamField body="async" type="boolean">
+  Whether to perform the operation asynchronously.
+  Defaults to synchronous.
+</ParamField>
+
+
+
+<RequestExample>
+```ts Sync
+await redis.flushall();
+```
+```ts Async
+await redis.flushall({async: true})
+```
+</RequestExample>

package/docs/commands/server/flushdb.mdx

@@ -0,0 +1,25 @@
+---
+title: FLUSHDB
+---
+
+
+<Warning>
+Deletes all keys permanently. Use with caution!
+</Warning>
+## Arguments
+
+<ParamField body="async" type="boolean">
+  Whether to perform the operation asynchronously.
+  Defaults to synchronous.
+</ParamField>
+
+
+
+<RequestExample>
+```ts Sync
+await redis.flushdb();
+```
+```ts Async
+await redis.flushdb({async: true})
+```
+</RequestExample>

package/docs/commands/set/sadd.mdx

@@ -0,0 +1,32 @@
+---
+title: SADD
+description: Adds one or more members to a set.
+---
+
+## Arguments
+
+<ParamField body="key" type="string" required>
+  The key of the set.
+</ParamField>
+
+<ParamField body="members" type="...TValue[]" required>
+  One or more members to add to the set.
+</ParamField>
+
+
+## Response
+
+<ResponseField type="number" required>
+  The number of elements that were added to the set, not including all the elements already present in the set.
+</ResponseField>
+
+<RequestExample>
+```ts Example 
+// 3
+await redis.sadd("key", "a", "b", "c"); 
+
+// 0
+await redis.sadd("key", "a", "b"); 
+```
+
+</RequestExample>

package/docs/commands/set/scard.mdx

@@ -0,0 +1,26 @@
+---
+title: SCARD
+description: Return how many members are in a set
+---
+
+## Arguments
+
+<ParamField body="key" type="string" required>
+  The key of the set.
+</ParamField>
+
+
+## Response
+
+<ResponseField type="number" required>
+  How many members are in the set.
+</ResponseField>
+
+<RequestExample>
+```ts Example 
+await redis.sadd("key", "a", "b", "c"); 
+const cardinality = await redis.scard("key");
+console.log(cardinality); // 3
+```
+
+</RequestExample>

package/docs/commands/set/sdiff.mdx

@@ -0,0 +1,27 @@
+---
+title: SDIFF
+description: Return the difference between sets
+---
+
+## Arguments
+
+<ParamField body="keys" type="...string[]" required>
+  The keys of the sets to perform the difference operation on.
+</ParamField>
+
+
+## Response
+
+<ResponseField type="TValue[]" required>
+  The members of the resulting set.
+</ResponseField>
+
+<RequestExample>
+```ts Example 
+await redis.sadd("set1", "a", "b", "c"); 
+await redis.sadd("set2", "c", "d", "e"); 
+const diff =  await redis.sdiff("set1", "set2");
+console.log(diff); // ["a", "b"]
+```
+
+</RequestExample>

package/docs/commands/set/sdiffstore.mdx

@@ -0,0 +1,32 @@
+---
+title: SDIFFSTORE
+description: Write the difference between sets to a new set
+---
+
+## Arguments
+
+<ParamField body="destination" type="string" required>
+  The key of the set to store the resulting set in.
+</ParamField>
+
+
+<ParamField body="keys" type="...string[]" required>
+  The keys of the sets to perform the difference operation on.
+</ParamField>
+
+
+## Response
+
+<ResponseField type="TValue[]" required>
+  The members of the resulting set.
+</ResponseField>
+
+<RequestExample>
+```ts Example 
+await redis.sadd("set1", "a", "b", "c"); 
+await redis.sadd("set2", "c", "d", "e"); 
+await redis.sdiff("dest", "set1", "set2");
+console.log(diff); // ["a", "b"]
+```
+
+</RequestExample>

package/docs/commands/set/sinter.mdx

@@ -0,0 +1,27 @@
+---
+title: SINTER
+description: Return the intersection between sets
+---
+
+## Arguments
+
+<ParamField body="keys" type="...string[]" required>
+  The keys of the sets to perform the intersection operation on.
+</ParamField>
+
+
+## Response
+
+<ResponseField type="TValue[]" required>
+  The members of the resulting set.
+</ResponseField>
+
+<RequestExample>
+```ts Example 
+await redis.sadd("set1", "a", "b", "c"); 
+await redis.sadd("set2", "c", "d", "e"); 
+const intersection =  await redis.sinter("set1", "set2");
+console.log(intersection); // ["c"]
+```
+
+</RequestExample>

package/docs/commands/set/sinterstore.mdx

@@ -0,0 +1,33 @@
+---
+title: SINTERSTORE
+description: Return the intersection between sets and store the resulting set in a key
+---
+
+## Arguments
+
+
+
+<ParamField body="destination" type="string" required>
+  The key of the set to store the resulting set in.
+</ParamField>
+
+
+<ParamField body="keys" type="...string[]" required>
+  The keys of the sets to perform the intersection operation on.
+</ParamField>
+
+
+## Response
+
+<ResponseField type="TValue[]" required>
+  The members of the resulting set.
+</ResponseField>
+
+<RequestExample>
+```ts Example 
+await redis.sadd("set1", "a", "b", "c"); 
+await redis.sadd("set2", "c", "d", "e"); 
+await redis.sinterstore("destination", "set1", "set2");
+```
+
+</RequestExample>

package/docs/commands/set/sismember.mdx

@@ -0,0 +1,30 @@
+---
+title: SISMEMBER
+description: Check if a member exists in a set
+---
+
+## Arguments
+
+<ParamField body="key" type="string" required>
+  The key of the set to check.
+</ParamField>
+
+<ParamField body="member" type="TMember">
+  The member to check for.
+</ParamField>
+
+
+## Response
+
+<ResponseField type="0 | 1" required>
+  `1` if the member exists in the set, `0` if not.
+</ResponseField>
+
+<RequestExample>
+```ts Example 
+await redis.sadd("set", "a", "b", "c"); 
+const isMember =  await redis.sismember("set", "a");
+console.log(isMember); // 1
+```
+
+</RequestExample>

package/docs/commands/set/smembers.mdx

@@ -0,0 +1,25 @@
+---
+title: SMEMBERS
+description: Return all the members of a set
+---
+
+## Arguments
+
+<ParamField body="key" type="string" required>
+  The key of the set.
+</ParamField>
+
+## Response
+
+<ResponseField type="TMember[]" required>
+  The members of the set.
+</ResponseField>
+
+<RequestExample>
+```ts Example 
+await redis.sadd("set", "a", "b", "c"); 
+const members =  await redis.smembers("set");
+console.log(members); // ["a", "b", "c"]
+```
+
+</RequestExample>

package/docs/commands/set/smismember.mdx

@@ -0,0 +1,31 @@
+---
+title: SMISMEMBER
+description: Check if multiple members exist in a set
+---
+
+## Arguments
+
+<ParamField body="key" type="string" required>
+  The key of the set to check.
+</ParamField>
+
+<ParamField body="members" type="TMember[]">
+  The members to check
+</ParamField>
+
+
+## Response
+
+<ResponseField type="(0 | 1)[]" required>
+  An array of `0` and `1` values.
+  `1` if the member exists in the set, `0` if not.
+</ResponseField>
+
+<RequestExample>
+```ts Example 
+await redis.sadd("set", "a", "b", "c"); 
+const members =  await redis.smismember("set", ["a", "b", "d"]);
+console.log(members); // [1, 1, 0]
+```
+
+</RequestExample>