@upstash/redis 0.0.0-ci.f8d46c0e → 0.0.0-ci.fb6b986f-20221006

package/types/pkg/script.d.ts

@@ -0,0 +1,42 @@
+import { Redis } from "./redis.js";
+/**
+ * Creates a new script.
+ *
+ * Scripts offer the ability to optimistically try to execute a script without having to send the
+ * entire script to the server. If the script is loaded on the server, it tries again by sending
+ * the entire script. Afterwards, the script is cached on the server.
+ *
+ * @example
+ * ```ts
+ * const redis = new Redis({...})
+ *
+ * const script = redis.createScript<string>("return ARGV[1];")
+ * const arg1 = await script.eval([], ["Hello World"])
+ * assertEquals(arg1, "Hello World")
+ * ```
+ */
+export declare class Script<TResult = unknown> {
+    readonly script: string;
+    readonly sha1: string;
+    private readonly redis;
+    constructor(redis: Redis, script: string);
+    /**
+     * Send an `EVAL` command to redis.
+     */
+    eval(keys: string[], args: string[]): Promise<TResult>;
+    /**
+     * Calculates the sha1 hash of the script and then calls `EVALSHA`.
+     */
+    evalsha(keys: string[], args: string[]): Promise<TResult>;
+    /**
+     * Optimistically try to run `EVALSHA` first.
+     * If the script is not loaded in redis, it will fall back and try again with `EVAL`.
+     *
+     * Following calls will be able to use the cached script
+     */
+    exec(keys: string[], args: string[]): Promise<TResult>;
+    /**
+     * Compute the sha1 hash of the script and return its hex representation.
+     */
+    private digest;
+}