@devvit/public-api 0.11.0-next-2024-07-30-8f65a4fa6.0 → 0.11.0-next-2024-07-30-0415fdb14.0

package/types/redis.d.ts

@@ -4,24 +4,96 @@ export type TxClientLike = {
      * Executes all previously queued commands in a transaction and
      * restores the connection state to normal. https://redis.io/commands/exec/
      * @returns array, each element being the reply to each of the commands in the atomic transaction.
+     * @example
+     * ```ts
+     * async function execExample(context: Devvit.Context) {
+     *  await context.redis.set("karma", "32");
+     *
+     *  const txn = await context.redis.watch("quantity");
+     *
+     *  await txn.multi();  // Begin a transaction
+     *  await txn.incrBy("karma", 10);
+     *  await txn.exec();   // Execute the commands in the transaction
+     * }
+     * ```
      */
     exec(): Promise<any[]>;
     /**
      * Marks the start of a transaction block. Subsequent commands will be
      * queued for atomic execution using EXEC. https://redis.io/commands/multi/
+     * @example
+     * ```ts
+     * async function multiExample(context: Devvit.Context) {
+     *  await context.redis.set("karma", "32");
+     *
+     *  const txn = await context.redis.watch("quantity");
+     *
+     *  await txn.multi();  // Begin a transaction
+     *  await txn.incrBy("karma", 10);
+     *  await txn.exec();   // Execute the commands in the transaction
+     * }
+     * ```
      */
     multi(): Promise<void>;
+    /**
+     * Flushes all previously queued commands in a transaction and restores the connection state to normal.
+     * If WATCH was used, DISCARD unwatches all keys watched by the connection. https://redis.io/docs/latest/commands/discard/
+     * @example
+     * ```ts
+     * async function discardExample(context: Devvit.Context) {
+     *  await context.redis.set("price", "25");
+     *
+     *  const txn = await context.redis.watch("price");
+     *
+     *  await txn.multi();     // Begin a transaction
+     *  await txn.incrBy("price", 5);
+     *  await txn.discard();   // Discard the commands in the transaction
+     * }
+     * ```
+     */
     discard(): Promise<void>;
     /**
      * Marks the given keys to be watched for conditional execution of a transaction.
      * https://redis.io/commands/watch/
      * @arg {} keys - given keys to be watched
+     * @example
+     * ```ts
+     * async function watchExample(context: Devvit.Context) {
+     *  await context.redis.set("karma", "32");
+     *
+     *  const txn = await context.redis.watch("quantity");
+     *
+     *  await txn.multi();  // Begin a transaction
+     *  await txn.incrBy("karma", 10);
+     *  await txn.exec();   // Execute the commands in the transaction
+     * }
+     * ```
      */
     watch(...keys: string[]): Promise<TxClientLike>;
     /**
      * Flushes all the previously watched keys for a transaction.
      * If you call EXEC or DISCARD, there's no need to manually call UNWATCH.
      * https://redis.io/commands/unwatch/
+     * @example
+     * ```ts
+     * async function unwatchExample(context: Devvit.Context) {
+     *  await context.redis.set("gold", "50");
+     *
+     *  const txn = await context.redis.watch("gold");
+     *
+     *  await txn.multi();     // Begin a transaction
+     *  await txn.incrBy("gold", 30);
+     *  await txn.unwatch();   // Unwatch "gold"
+     *
+     *  // Now that "gold" has been unwatched, we can increment its value
+     *  // outside the transaction without canceling the transaction
+     *  await context.redis.incrBy("gold", -20);
+     *
+     *  await txn.exec();   // Execute the commands in the transaction
+     *
+     *  console.log("Gold value: " + await context.redis.get("gold")); // The value of 'gold' should be 50 + 30 - 20 = 60
+     * }
+     * ```
      */
     unwatch(): Promise<TxClientLike>;
     /**
@@ -29,6 +101,14 @@ export type TxClientLike = {
      * https://redis.io/commands/get/
      * @arg {} key
      * @returns value of key or null when key does not exist.
+     * @example
+     * ```ts
+     * async function getExample(context: Devvit.Context) {
+     *  await context.redis.set("quantity", "5");
+     *  const quantity : string | undefined = await context.redis.get("quantity");
+     *  console.log("Quantity: " + quantity);
+     * }
+     * ```
      */
     get(key: string): Promise<TxClientLike>;
     /**
@@ -37,12 +117,25 @@ export type TxClientLike = {
      * @arg {} key
      * @arg {} value
      * @arg {} options
+     * @example
+     * ```ts
+     * async function setExample(context: Devvit.Context) {
+     *  await context.redis.set("quantity", "5");
+     * }
+     * ```
      */
     set(key: string, value: string, options?: SetOptions): Promise<TxClientLike>;
     /**
      * Removes the specified keys. A key is ignored if it does not exist.
      * https://redis.io/commands/del/
      * @arg {} keys
+     * @example
+     * ```ts
+     * async function delExample(context: Devvit.Context) {
+     *  await context.redis.set("quantity", "5");
+     *  await context.redis.del("quantity");
+     * }
+     * ```
      */
     del(...keys: string[]): Promise<TxClientLike>;
     /**
@@ -50,6 +143,14 @@ export type TxClientLike = {
      * https://redis.io/commands/incrby/
      * @arg {} key
      * @arg {} value
+     * @example
+     * ```ts
+     * async function incrByExample(context: Devvit.Context) {
+     *  await context.redis.set("totalPoints", "53")
+     *  const updatedPoints : number = await context.redis.incrBy("totalPoints", 100);
+     *  console.log("Updated points: " + updatedPoints);
+     * }
+     * ```
      */
     incrBy(key: string, value: number): Promise<TxClientLike>;
     /**
@@ -57,6 +158,14 @@ export type TxClientLike = {
      * https://redis.io/commands/type/
      * @arg {} key
      * @returns string representation of the type
+     * @example
+     * ```ts
+     * async function typeExample(context: Devvit.Context) {
+     *  await context.redis.set("quantity", "5");
+     *  const type : string = await context.redis.type("quantity");
+     *  console.log("Key type: " + type);
+     * }
+     * ```
      */
     type(key: string): Promise<TxClientLike>;
     /**
@@ -67,6 +176,14 @@ export type TxClientLike = {
      * @arg {} start
      * @arg {} end
      * @returns substring determined by offsets [start, end]
+     * @example
+     * ```ts
+     * async function getRangeExample(context: Devvit.Context) {
+     *  await context.redis.set("word", "tacocat");
+     *  const range : string = await context.redis.getRange("word", 0, 3)
+     *  console.log("Range from index 0 to 3: " + range);
+     * }
+     * ```
      */
     getRange(key: string, start: number, end: number): Promise<TxClientLike>;
     /**
@@ -76,6 +193,13 @@ export type TxClientLike = {
      * @arg {} key
      * @arg {} offset
      * @returns length of the string after it was modified by the command
+     * @example
+     * ```ts
+     * async function setRangeExample(context: Devvit.Context) {
+     *  await context.redis.set("word", "tacocat");
+     *  await context.redis.setRange("word", 0, "blue");
+     * }
+     * ```
      */
     setRange(key: string, offset: number, value: string): Promise<TxClientLike>;
     /**
@@ -93,6 +217,14 @@ export type TxClientLike = {
      * https://redis.io/commands/strlen/
      * @arg {} key
      * @returns length of the string stored at key
+     * @example
+     * ```ts
+     * async function strLenExample(context: Devvit.Context) {
+     *  await context.redis.set("word", "tacocat");
+     *  const length : number = await context.redis.strLen("word");
+     *  console.log("Length of word: " + length);
+     * }
+     * ```
      */
     strLen(key: string): Promise<TxClientLike>;
     /**
@@ -108,6 +240,16 @@ export type TxClientLike = {
      * https://redis.io/commands/mget/
      * @arg {} keys
      * @returns list of values at the specified keys
+     * @example
+     * ```ts
+     * async function mGetExample(context: Devvit.Context) {
+     *  await context.redis.mSet({"name": "Zeek", "occupation": "Developer"});
+     *  const result : (string | null)[] = await context.redis.mGet(["name", "occupation"]);
+     *  result.forEach(x => {
+     *    console.log(x);
+     *  });
+     * }
+     * ```
      */
     mGet(keys: string[]): Promise<TxClientLike>;
     /**
@@ -123,6 +265,12 @@ export type TxClientLike = {
      * Sets the given keys to their respective values.
      * https://redis.io/commands/mset/
      * @arg {} keyValues
+     * @example
+     * ```ts
+     * async function mSetExample(context: Devvit.Context) {
+     *  await context.redis.mSet({"name": "Zeek", "occupation": "Developer"});
+     * }
+     * ```
      */
     mSet(keyValues: {
         [key: string]: string;
@@ -132,6 +280,13 @@ export type TxClientLike = {
      * https://redis.io/commands/expire/
      * @arg {} key
      * @arg {} seconds
+     * @example
+     * ```ts
+     * async function expireExample(context: Devvit.Context) {
+     *  await context.redis.set("product", "milk");
+     *  await context.redis.expire("product", 60);   // Set the product to expire in 60 seconds
+     * }
+     * ```
      */
     expire(key: string, seconds: number): Promise<TxClientLike>;
     /**
@@ -139,6 +294,12 @@ export type TxClientLike = {
      * https://redis.io/commands/expiretime/
      * @arg {} key
      * @returns expiration Unix timestamp in seconds, or a negative value in order to signal an error
+     * @example
+     * async function expireTimeExample(context: Devvit.Context) {
+     *  await context.redis.set("product", "milk");
+     *  const expireTime : number = await context.redis.expireTime("product");
+     *  console.log("Expire time: " + expireTime);
+     * }
      */
     expireTime(key: string): Promise<TxClientLike>;
     /**
@@ -146,6 +307,18 @@ export type TxClientLike = {
      * https://redis.io/commands/zadd/
      * @arg {} key
      * @returns number of elements added to the sorted set
+     * @example
+     * ```ts
+     * async function zAddExample(context: Devvit.Context) {
+     *  const numMembersAdded : number = await context.redis.zAdd("leaderboard",
+     *    {member: "louis", score: 37},
+     *    {member: "fernando", score: 10},
+     *    {member: "caesar", score: 20},
+     *    {member: "alexander", score: 25},
+     *  );
+     *  console.log("Number of members added: " + numMembersAdded);
+     * }
+     * ```
      */
     zAdd(key: string, ...members: ZMember[]): Promise<TxClientLike>;
     /**
@@ -153,6 +326,19 @@ export type TxClientLike = {
      * https://redis.io/commands/zcard/
      * @arg {} key
      * @returns cardinality of the sorted set
+     * @example
+     * ```ts
+     * async function zCardExample(context: Devvit.Context) {
+     *  await context.redis.zAdd("leaderboard",
+     *    {member: "louis", score: 37},
+     *    {member: "fernando", score: 10},
+     *    {member: "caesar", score: 20},
+     *    {member: "alexander", score: 25},
+     *  );
+     *  const cardinality : number = await context.redis.zCard("leaderboard");
+     *  console.log("Cardinality: " + cardinality);
+     * }
+     * ```
      */
     zCard(key: string): Promise<TxClientLike>;
     /**
@@ -162,6 +348,19 @@ export type TxClientLike = {
      * @arg {} member
      * @arg {} value
      * @returns the new score of member as a double precision floating point number
+     * @example
+     * ```ts
+     * async function zIncrByExample(context: Devvit.Context) {
+     *  await context.redis.zAdd("animals",
+     *    {member: "zebra", score: 92},
+     *    {member: "cat", score: 100},
+     *    {member: "dog", score: 95},
+     *    {member: "elephant", score: 97}
+     *  );
+     *  const updatedScore : number = await context.redis.zIncrBy("animals", "dog", 10);
+     *  console.log("Dog's updated score: " + updatedScore);
+     * }
+     * ```
      */
     zIncrBy(key: string, member: string, value: number): Promise<TxClientLike>;
     /**
@@ -171,6 +370,19 @@ export type TxClientLike = {
      * @arg {} member
      * @returns rank of the member. The rank (or index) is 0-based
      * which means that the member with the lowest score has rank 0
+     * @example
+     * ```ts
+     * async function zRankExample(context: Devvit.Context) {
+     *  await context.redis.zAdd("animals",
+     *    {member: "zebra", score: 92},
+     *    {member: "cat", score: 100},
+     *    {member: "dog", score: 95},
+     *    {member: "elephant", score: 97}
+     *  );
+     *  const rank : number = await context.redis.zRank("animals", "dog");
+     *  console.log("Dog's rank: " + rank);
+     * }
+     * ```
      */
     zRank(key: string, member: string): Promise<TxClientLike>;
     /**
@@ -179,6 +391,19 @@ export type TxClientLike = {
      * @arg {} key
      * @arg {} member
      * @returns the score of the member (a double-precision floating point number).
+     * @example
+     * ```ts
+     * async function zScoreExample(context: Devvit.Context) {
+     *  await context.redis.zAdd("leaderboard",
+     *    {member: "louis", score: 37},
+     *    {member: "fernando", score: 10},
+     *    {member: "caesar", score: 20},
+     *    {member: "alexander", score: 25},
+     *  );
+     *  const score : number = await context.redis.zScore("leaderboard", "caesar");
+     *  console.log("Caesar's score: " + score);
+     * }
+     * ```
      */
     zScore(key: string, member: string): Promise<TxClientLike>;
     /**
@@ -187,6 +412,20 @@ export type TxClientLike = {
      * @arg {} cursor
      * @arg {} pattern
      * @arg {} count
+     * @example
+     * ```ts
+     * async function zScanExample(context: Devvit.Context) {
+     *  await context.redis.zAdd("fruits",
+     *    {member: "kiwi", score: 0},
+     *    {member: "mango", score: 0},
+     *    {member: "banana", score: 0},
+     *    {member: "orange", score: 0},
+     *    {member: "apple", score: 0},
+     *  );
+     *  const zScanResponse = await context.redis.zScan("fruits", 0);
+     *  console.log("zScanResponse: " + JSON.stringify(zScanResponse));
+     * }
+     * ```
      */
     zScan(key: string, cursor: number, pattern?: string | undefined, count?: number | undefined): Promise<TxClientLike>;
     /**
@@ -197,6 +436,24 @@ export type TxClientLike = {
      * @arg {} stop
      * @arg {} options
      * @returns list of elements in the specified range
+     * @example
+     * ```ts
+     * async function zRangeExample(context: Devvit.Context) {
+     *  await context.redis.zAdd("leaderboard",
+     *    {member: "louis", score: 37},
+     *    {member: "fernando", score: 10},
+     *    {member: "caesar", score: 20},
+     *    {member: "alexander", score: 25},
+     *  );
+     *
+     *  // View elements with scores between 0 and 30 inclusive, sorted by score
+     *  const scores : {member : string, score : number}[] = await context.redis.zRange("leaderboard", 0, 30, { by: "score" });
+     *
+     *  scores.forEach(x => {
+     *    console.log("Member: " + x.member, ", Score: " + x.score);
+     *  });
+     * }
+     * ```
      */
     zRange(key: string, start: number | string, stop: number | string, options?: ZRangeOptions): Promise<TxClientLike>;
     /**
@@ -205,6 +462,19 @@ export type TxClientLike = {
      * @arg {} key
      * @arg {} members
      * @returns number of members removed from the sorted set
+     * @example
+     * ```ts
+     * async function zRemExample(context: Devvit.Context) {
+     *  await context.redis.zAdd("leaderboard",
+     *    {member: "louis", score: 37},
+     *    {member: "fernando", score: 10},
+     *    {member: "caesar", score: 20},
+     *    {member: "alexander", score: 25},
+     *  );
+     *  const numberOfMembersRemoved : number = await context.redis.zRem("leaderboard", ["fernando", "alexander"]);
+     *  console.log("Number of members removed: " + numberOfMembersRemoved);
+     * }
+     * ```
      */
     zRem(key: string, members: string[]): Promise<TxClientLike>;
     /**
@@ -215,6 +485,23 @@ export type TxClientLike = {
      * @arg {} min
      * @arg {} max
      * @returns number of members removed from the sorted set
+     * @example
+     * ```ts
+     * async function zRemRangeByLexExample(context: Devvit.Context) {
+     *  await context.redis.zAdd("fruits",
+     *    {member: "kiwi", score: 0},
+     *    {member: "mango", score: 0},
+     *    {member: "banana", score: 0},
+     *    {member: "orange", score: 0},
+     *    {member: "apple", score: 0},
+     *  );
+     *
+     *  // Remove fruits alphabetically ordered between 'kiwi' inclusive and 'orange' exclusive
+     *  // Note: The symbols '[' and '(' indicate inclusive or exclusive, respectively. These must be included in the call to zRemRangeByLex().
+     *  const numFieldsRemoved : number = await context.redis.zRemRangeByLex("fruits", "[kiwi", "(orange");
+     *  console.log("Number of fields removed: " + numFieldsRemoved);
+     * }
+     * ```
      */
     zRemRangeByLex(key: string, min: string, max: string): Promise<TxClientLike>;
     /**
@@ -224,6 +511,22 @@ export type TxClientLike = {
      * @arg {} start
      * @arg {} stop
      * @returns number of members removed from the sorted set
+     * @example
+     * ```
+     * async function zRemRangeByRankExample(context: Devvit.Context) {
+     *  await context.redis.zAdd("fruits",
+     *    {member: "kiwi", score: 10},
+     *    {member: "mango", score: 20},
+     *    {member: "banana", score: 30},
+     *    {member: "orange", score: 40},
+     *    {member: "apple", score: 50},
+     *  );
+  
+     *  // Remove fruits ranked 1 through 3 inclusive
+     *  const numFieldsRemoved : number = await context.redis.zRemRangeByRank("fruits", 1, 3);
+     *  console.log("Number of fields removed: " + numFieldsRemoved);
+     * }
+     * ```
      */
     zRemRangeByRank(key: string, start: number, stop: number): Promise<TxClientLike>;
     /**
@@ -233,6 +536,21 @@ export type TxClientLike = {
      * @arg {} min
      * @arg {} max
      * @returns number of members removed from the sorted set
+     * @example
+     * ```ts
+     * async function zRemRangeByScoreExample(context: Devvit.Context) {
+     *  await context.redis.zAdd("fruits",
+     *    {member: "kiwi", score: 10},
+     *    {member: "mango", score: 20},
+     *    {member: "banana", score: 30},
+     *    {member: "orange", score: 40},
+     *    {member: "apple", score: 50},
+     *  );
+     *  // Remove fruits scored between 30 and 50 inclusive
+     *  const numFieldsRemoved : number = await context.redis.zRemRangeByScore("fruits", 30, 50);
+     *  console.log("Number of fields removed: " + numFieldsRemoved);
+     * }
+     * ```
      */
     zRemRangeByScore(key: string, min: number, max: number): Promise<TxClientLike>;
     /**
@@ -252,6 +570,13 @@ export type TxClientLike = {
      * @arg {} key
      * @arg {} fieldValues
      * @returns number of fields that were added
+     * @example
+     * ```ts
+     * async function hSetExample(context: Devvit.Context) {
+     *  const numFieldsAdded = await context.redis.hSet("fruits", {"apple": "5", "orange": "7", "kiwi": "9"});
+     *  console.log("Number of fields added: " + numFieldsAdded);
+     * }
+     * ```
      */
     hSet(key: string, fieldValues: {
         [field: string]: string;
@@ -271,6 +596,14 @@ export type TxClientLike = {
      * @arg {} key
      * @arg {} field
      * @returns value associated with field
+     * @example
+     * ```ts
+     * async function hGetExample(context: Devvit.Context) {
+     *  await context.redis.hSet("fruits", {"apple": "5", "orange": "7", "kiwi": "9"});
+     *  const result : string | undefined = await context.redis.hGet("fruits", "orange");
+     *  console.log("Value of orange: " + result);
+     * }
+     * ```
      */
     hGet(key: string, field: string): Promise<TxClientLike>;
     /**
@@ -286,6 +619,22 @@ export type TxClientLike = {
      * https://redis.io/commands/hgetall
      * @arg {} key
      * @returns a map of fields and their values stored in the hash,
+     * @example
+     * ```
+     * async function hGetAllExample(context: Devvit.Context) {
+     *  await context.redis.hSet("groceryList", {
+     *   "eggs": "12",
+     *   "apples": "3",
+     *   "milk": "1"
+     *  });
+     *
+     *  const record : Record<string, string> | undefined = await context.redis.hGetAll("groceryList");
+     *
+     *  if (record != undefined) {
+     *   console.log("Eggs: " + record.eggs + ", Apples: " + record.apples + ", Milk: " + record.milk);
+     *  }
+     * }
+     * ```
      */
     hGetAll(key: string): Promise<TxClientLike>;
     /**
@@ -303,6 +652,14 @@ export type TxClientLike = {
      * @arg {} key
      * @arg {} fields
      * @returns number of fields that were removed from the hash
+     * @example
+     * ```ts
+     * async function hDelExample(context: Devvit.Context) {
+     *  await context.redis.hSet("fruits", {"apple": "5", "orange": "7", "kiwi": "9"});
+     *  const numFieldsRemoved = await context.redis.hDel("fruits", ["apple", "kiwi"]);
+     *  console.log("Number of fields removed: " + numFieldsRemoved);
+     * }
+     * ```
      */
     hDel(key: string, fields: string[]): Promise<TxClientLike>;
     /**
@@ -320,6 +677,22 @@ export type TxClientLike = {
      * @arg {} cursor
      * @arg {} pattern
      * @arg {} count
+     * @example
+     * ```ts
+     * async function hScanExample(context: Devvit.Context) {
+     *  await context.redis.hSet("userInfo", {
+     *    "name": "Bob",
+     *    "startDate": "01-05-20",
+     *    "totalAwards": "12"
+     *  });
+     *
+     *  const hScanResponse = await context.redis.hScan("userInfo", 0);
+     *
+     *  hScanResponse.fieldValues.forEach(x => {
+     *    console.log("Field: '" + x.field + "', Value: '" + x.value + "'");
+     *  });
+     * }
+     * ```
      */
     hScan(key: string, cursor: number, pattern?: string | undefined, count?: number | undefined): Promise<TxClientLike>;
     /**
@@ -331,6 +704,18 @@ export type TxClientLike = {
     /**
      * Returns all field names in the hash stored at key.
      * @arg {} key
+     * @example
+     * ```ts
+     * async function hKeysExample(context: Devvit.Context) {
+     *  await context.redis.hSet("prices", {
+     *    "chair": "48",
+     *    "desk": "95",
+     *    "whiteboard": "23"
+     *  });
+     *  const keys : string[] = await context.redis.hKeys("prices");
+     *  console.log("Keys: " + keys);
+     * }
+     * ```
      */
     hKeys(key: string): Promise<TxClientLike>;
     /**
@@ -350,6 +735,13 @@ export type TxClientLike = {
      * @arg {} field
      * @arg {} value
      * @returns value of key after the increment
+     * @example
+     * ```ts
+     * async function hIncrByExample(context: Devvit.Context) {
+     *  await context.redis.hSet("user123", { "karma": "100" });
+     *  await context.redis.hIncrBy("user123", "karma", 5);
+     * }
+     * ```
      */
     hIncrBy(key: string, field: string, value: number): Promise<TxClientLike>;
     /**
@@ -363,6 +755,19 @@ export type TxClientLike = {
      * Returns the number of fields contained in the hash stored at key.
      * @arg {} key
      * @returns the number of fields in the hash, or 0 when the key does not exist.
+     * @example
+     * ```ts
+     * async function hLenExample(context: Devvit.Context) {
+     *  await context.redis.hSet("supplies", {
+     *    "paperclips": "25",
+     *    "pencils": "10",
+     *    "erasers": "5",
+     *    "pens": "7"
+     *  });
+     *  const numberOfFields : number = await context.redis.hLen("supplies");
+     *  console.log("Number of fields: " + numberOfFields);
+     * }
+     * ```
      */
     hLen(key: string): Promise<TxClientLike>;
 };
@@ -371,6 +776,18 @@ export type RedisClient = {
      * Marks the given keys to be watched for conditional execution of a transaction.
      * https://redis.io/commands/watch/
      * @arg {} keys - given keys to be watched
+     * @example
+     * ```ts
+     * async function watchExample(context: Devvit.Context) {
+     *  await context.redis.set("karma", "32");
+     *
+     *  const txn = await context.redis.watch("quantity");
+     *
+     *  await txn.multi();  // Begin a transaction
+     *  await txn.incrBy("karma", 10);
+     *  await txn.exec();   // Execute the commands in the transaction
+     * }
+     * ```
      */
     watch(...keys: string[]): Promise<TxClientLike>;
     /**
@@ -378,6 +795,14 @@ export type RedisClient = {
      * https://redis.io/commands/get/
      * @arg {} key
      * @returns value of key or null when key does not exist.
+     * @example
+     * ```ts
+     * async function getExample(context: Devvit.Context) {
+     *  await context.redis.set("quantity", "5");
+     *  const quantity : string | undefined = await context.redis.get("quantity");
+     *  console.log("Quantity: " + quantity);
+     * }
+     * ```
      */
     get(key: string): Promise<string | undefined>;
     /**
@@ -386,12 +811,25 @@ export type RedisClient = {
      * @arg {} key
      * @arg {} value
      * @arg {} options
+     * @example
+     * ```ts
+     * async function setExample(context: Devvit.Context) {
+     *  await context.redis.set("quantity", "5");
+     * }
+     * ```
      */
     set(key: string, value: string, options?: SetOptions): Promise<string>;
     /**
      * Removes the specified keys. A key is ignored if it does not exist.
      * https://redis.io/commands/del/
      * @arg {} keys
+     * @example
+     * ```ts
+     * async function delExample(context: Devvit.Context) {
+     *  await context.redis.set("quantity", "5");
+     *  await context.redis.del("quantity");
+     * }
+     * ```
      */
     del(...keys: string[]): Promise<void>;
     /**
@@ -399,6 +837,14 @@ export type RedisClient = {
      * https://redis.io/commands/type/
      * @arg {} key
      * @returns string representation of the type
+     * @example
+     * ```ts
+     * async function typeExample(context: Devvit.Context) {
+     *  await context.redis.set("quantity", "5");
+     *  const type : string = await context.redis.type("quantity");
+     *  console.log("Key type: " + type);
+     * }
+     * ```
      */
     type(key: string): Promise<string>;
     /**
@@ -409,6 +855,14 @@ export type RedisClient = {
      * @arg {} start
      * @arg {} end
      * @returns substring determined by offsets [start, end]
+     * @example
+     * ```ts
+     * async function getRangeExample(context: Devvit.Context) {
+     *  await context.redis.set("word", "tacocat");
+     *  const range : string = await context.redis.getRange("word", 0, 3)
+     *  console.log("Range from index 0 to 3: " + range);
+     * }
+     * ```
      */
     getRange(key: string, start: number, end: number): Promise<string>;
     /**
@@ -418,6 +872,13 @@ export type RedisClient = {
      * @arg {} key
      * @arg {} offset
      * @returns length of the string after it was modified by the command
+     * @example
+     * ```ts
+     * async function setRangeExample(context: Devvit.Context) {
+     *  await context.redis.set("word", "tacocat");
+     *  await context.redis.setRange("word", 0, "blue");
+     * }
+     * ```
      */
     setRange(key: string, offset: number, value: string): Promise<number>;
     /**
@@ -435,6 +896,14 @@ export type RedisClient = {
      * https://redis.io/commands/strlen/
      * @arg {} key
      * @returns length of the string stored at key
+     * @example
+     * ```ts
+     * async function strLenExample(context: Devvit.Context) {
+     *  await context.redis.set("word", "tacocat");
+     *  const length : number = await context.redis.strLen("word");
+     *  console.log("Length of word: " + length);
+     * }
+     * ```
      */
     strLen(key: string): Promise<number>;
     /**
@@ -443,6 +912,14 @@ export type RedisClient = {
      * @arg {} key
      * @arg {} value
      * @returns value of key after the increment
+     * @example
+     * ```ts
+     * async function incrByExample(context: Devvit.Context) {
+     *  await context.redis.set("totalPoints", "53")
+     *  const updatedPoints : number = await context.redis.incrBy("totalPoints", 100);
+     *  console.log("Updated points: " + updatedPoints);
+     * }
+     * ```
      */
     incrBy(key: string, value: number): Promise<number>;
     /**
@@ -458,6 +935,16 @@ export type RedisClient = {
      * https://redis.io/commands/mget/
      * @arg {} keys
      * @returns list of values at the specified keys
+     * @example
+     * ```ts
+     * async function mGetExample(context: Devvit.Context) {
+     *  await context.redis.mSet({"name": "Zeek", "occupation": "Developer"});
+     *  const result : (string | null)[] = await context.redis.mGet(["name", "occupation"]);
+     *  result.forEach(x => {
+     *    console.log(x);
+     *  });
+     * }
+     * ```
      */
     mGet(keys: string[]): Promise<(string | null)[]>;
     /**
@@ -473,6 +960,12 @@ export type RedisClient = {
      * Sets the given keys to their respective values.
      * https://redis.io/commands/mset/
      * @arg {} keyValues
+     * @example
+     * ```ts
+     * async function mSetExample(context: Devvit.Context) {
+     *  await context.redis.mSet({"name": "Zeek", "occupation": "Developer"});
+     * }
+     * ```
      */
     mSet(keyValues: {
         [key: string]: string;
@@ -482,6 +975,13 @@ export type RedisClient = {
      * https://redis.io/commands/expire/
      * @arg {} key
      * @arg {} seconds
+     * @example
+     * ```ts
+     * async function expireExample(context: Devvit.Context) {
+     *  await context.redis.set("product", "milk");
+     *  await context.redis.expire("product", 60);   // Set the product to expire in 60 seconds
+     * }
+     * ```
      */
     expire(key: string, seconds: number): Promise<void>;
     /**
@@ -489,6 +989,12 @@ export type RedisClient = {
      * https://redis.io/commands/expiretime/
      * @arg {} key
      * @returns expiration Unix timestamp in seconds, or a negative value in order to signal an error
+     * @example
+     * async function expireTimeExample(context: Devvit.Context) {
+     *  await context.redis.set("product", "milk");
+     *  const expireTime : number = await context.redis.expireTime("product");
+     *  console.log("Expire time: " + expireTime);
+     * }
      */
     expireTime(key: string): Promise<number>;
     /**
@@ -496,6 +1002,18 @@ export type RedisClient = {
      * https://redis.io/commands/zadd/
      * @arg {} key
      * @returns number of elements added to the sorted set
+     * @example
+     * ```ts
+     * async function zAddExample(context: Devvit.Context) {
+     *  const numMembersAdded : number = await context.redis.zAdd("leaderboard",
+     *    {member: "louis", score: 37},
+     *    {member: "fernando", score: 10},
+     *    {member: "caesar", score: 20},
+     *    {member: "alexander", score: 25},
+     *  );
+     *  console.log("Number of members added: " + numMembersAdded);
+     * }
+     * ```
      */
     zAdd(key: string, ...members: ZMember[]): Promise<number>;
     /**
@@ -503,6 +1021,19 @@ export type RedisClient = {
      * https://redis.io/commands/zcard/
      * @arg {} key
      * @returns cardinality of the sorted set
+     * @example
+     * ```ts
+     * async function zCardExample(context: Devvit.Context) {
+     *  await context.redis.zAdd("leaderboard",
+     *    {member: "louis", score: 37},
+     *    {member: "fernando", score: 10},
+     *    {member: "caesar", score: 20},
+     *    {member: "alexander", score: 25},
+     *  );
+     *  const cardinality : number = await context.redis.zCard("leaderboard");
+     *  console.log("Cardinality: " + cardinality);
+     * }
+     * ```
      */
     zCard(key: string): Promise<number>;
     /**
@@ -511,6 +1042,19 @@ export type RedisClient = {
      * @arg {} key
      * @arg {} member
      * @returns the score of the member (a double-precision floating point number).
+     * @example
+     * ```ts
+     * async function zScoreExample(context: Devvit.Context) {
+     *  await context.redis.zAdd("leaderboard",
+     *    {member: "louis", score: 37},
+     *    {member: "fernando", score: 10},
+     *    {member: "caesar", score: 20},
+     *    {member: "alexander", score: 25},
+     *  );
+     *  const score : number = await context.redis.zScore("leaderboard", "caesar");
+     *  console.log("Caesar's score: " + score);
+     * }
+     * ```
      */
     zScore(key: string, member: string): Promise<number>;
     /**
@@ -520,6 +1064,19 @@ export type RedisClient = {
      * @arg {} member
      * @returns rank of the member. The rank (or index) is 0-based
      * which means that the member with the lowest score has rank 0
+     * @example
+     * ```ts
+     * async function zRankExample(context: Devvit.Context) {
+     *  await context.redis.zAdd("animals",
+     *    {member: "zebra", score: 92},
+     *    {member: "cat", score: 100},
+     *    {member: "dog", score: 95},
+     *    {member: "elephant", score: 97}
+     *  );
+     *  const rank : number = await context.redis.zRank("animals", "dog");
+     *  console.log("Dog's rank: " + rank);
+     * }
+     * ```
      */
     zRank(key: string, member: string): Promise<number>;
     /**
@@ -529,6 +1086,19 @@ export type RedisClient = {
      * @arg {} member
      * @arg {} value
      * @returns the new score of member as a double precision floating point number
+     * @example
+     * ```ts
+     * async function zIncrByExample(context: Devvit.Context) {
+     *  await context.redis.zAdd("animals",
+     *    {member: "zebra", score: 92},
+     *    {member: "cat", score: 100},
+     *    {member: "dog", score: 95},
+     *    {member: "elephant", score: 97}
+     *  );
+     *  const updatedScore : number = await context.redis.zIncrBy("animals", "dog", 10);
+     *  console.log("Dog's updated score: " + updatedScore);
+     * }
+     * ```
      */
     zIncrBy(key: string, member: string, value: number): Promise<number>;
     /**
@@ -539,6 +1109,24 @@ export type RedisClient = {
      * @arg {} stop
      * @arg {} options
      * @returns list of elements in the specified range
+     * @example
+     * ```ts
+     * async function zRangeExample(context: Devvit.Context) {
+     *  await context.redis.zAdd("leaderboard",
+     *    {member: "louis", score: 37},
+     *    {member: "fernando", score: 10},
+     *    {member: "caesar", score: 20},
+     *    {member: "alexander", score: 25},
+     *  );
+     *
+     *  // View elements with scores between 0 and 30 inclusive, sorted by score
+     *  const scores : {member : string, score : number}[] = await context.redis.zRange("leaderboard", 0, 30, { by: "score" });
+     *
+     *  scores.forEach(x => {
+     *    console.log("Member: " + x.member, ", Score: " + x.score);
+     *  });
+     * }
+     * ```
      */
     zRange(key: string, start: number | string, stop: number | string, options?: ZRangeOptions): Promise<{
         member: string;
@@ -550,6 +1138,19 @@ export type RedisClient = {
      * @arg {} key
      * @arg {} members
      * @returns number of members removed from the sorted set
+     * @example
+     * ```ts
+     * async function zRemExample(context: Devvit.Context) {
+     *  await context.redis.zAdd("leaderboard",
+     *    {member: "louis", score: 37},
+     *    {member: "fernando", score: 10},
+     *    {member: "caesar", score: 20},
+     *    {member: "alexander", score: 25},
+     *  );
+     *  const numberOfMembersRemoved : number = await context.redis.zRem("leaderboard", ["fernando", "alexander"]);
+     *  console.log("Number of members removed: " + numberOfMembersRemoved);
+     * }
+     * ```
      */
     zRem(key: string, members: string[]): Promise<number>;
     /**
@@ -560,6 +1161,23 @@ export type RedisClient = {
      * @arg {} min
      * @arg {} max
      * @returns number of members removed from the sorted set
+     * @example
+     * ```ts
+     * async function zRemRangeByLexExample(context: Devvit.Context) {
+     *  await context.redis.zAdd("fruits",
+     *    {member: "kiwi", score: 0},
+     *    {member: "mango", score: 0},
+     *    {member: "banana", score: 0},
+     *    {member: "orange", score: 0},
+     *    {member: "apple", score: 0},
+     *  );
+     *
+     *  // Remove fruits alphabetically ordered between 'kiwi' inclusive and 'orange' exclusive
+     *  // Note: The symbols '[' and '(' indicate inclusive or exclusive, respectively. These must be included in the call to zRemRangeByLex().
+     *  const numFieldsRemoved : number = await context.redis.zRemRangeByLex("fruits", "[kiwi", "(orange");
+     *  console.log("Number of fields removed: " + numFieldsRemoved);
+     * }
+     * ```
      */
     zRemRangeByLex(key: string, min: string, max: string): Promise<number>;
     /**
@@ -569,6 +1187,22 @@ export type RedisClient = {
      * @arg {} start
      * @arg {} stop
      * @returns number of members removed from the sorted set
+     * @example
+     * ```
+     * async function zRemRangeByRankExample(context: Devvit.Context) {
+     *  await context.redis.zAdd("fruits",
+     *    {member: "kiwi", score: 10},
+     *    {member: "mango", score: 20},
+     *    {member: "banana", score: 30},
+     *    {member: "orange", score: 40},
+     *    {member: "apple", score: 50},
+     *  );
+  
+     *  // Remove fruits ranked 1 through 3 inclusive
+     *  const numFieldsRemoved : number = await context.redis.zRemRangeByRank("fruits", 1, 3);
+     *  console.log("Number of fields removed: " + numFieldsRemoved);
+     * }
+     * ```
      */
     zRemRangeByRank(key: string, start: number, stop: number): Promise<number>;
     /**
@@ -578,6 +1212,21 @@ export type RedisClient = {
      * @arg {} min
      * @arg {} max
      * @returns number of members removed from the sorted set
+     * @example
+     * ```ts
+     * async function zRemRangeByScoreExample(context: Devvit.Context) {
+     *  await context.redis.zAdd("fruits",
+     *    {member: "kiwi", score: 10},
+     *    {member: "mango", score: 20},
+     *    {member: "banana", score: 30},
+     *    {member: "orange", score: 40},
+     *    {member: "apple", score: 50},
+     *  );
+     *  // Remove fruits scored between 30 and 50 inclusive
+     *  const numFieldsRemoved : number = await context.redis.zRemRangeByScore("fruits", 30, 50);
+     *  console.log("Number of fields removed: " + numFieldsRemoved);
+     * }
+     * ```
      */
     zRemRangeByScore(key: string, min: number, max: number): Promise<number>;
     /**
@@ -586,6 +1235,20 @@ export type RedisClient = {
      * @arg {} cursor
      * @arg {} pattern
      * @arg {} count
+     * @example
+     * ```ts
+     * async function zScanExample(context: Devvit.Context) {
+     *  await context.redis.zAdd("fruits",
+     *    {member: "kiwi", score: 0},
+     *    {member: "mango", score: 0},
+     *    {member: "banana", score: 0},
+     *    {member: "orange", score: 0},
+     *    {member: "apple", score: 0},
+     *  );
+     *  const zScanResponse = await context.redis.zScan("fruits", 0);
+     *  console.log("zScanResponse: " + JSON.stringify(zScanResponse));
+     * }
+     * ```
      */
     zScan(key: string, cursor: number, pattern?: string | undefined, count?: number | undefined): Promise<ZScanResponse>;
     /**
@@ -605,6 +1268,13 @@ export type RedisClient = {
      * @arg {} key
      * @arg {} fieldValues
      * @returns number of fields that were added
+     * @example
+     * ```ts
+     * async function hSetExample(context: Devvit.Context) {
+     *  const numFieldsAdded = await context.redis.hSet("fruits", {"apple": "5", "orange": "7", "kiwi": "9"});
+     *  console.log("Number of fields added: " + numFieldsAdded);
+     * }
+     * ```
      */
     hSet(key: string, fieldValues: {
         [field: string]: string;
@@ -624,6 +1294,14 @@ export type RedisClient = {
      * @arg {} key
      * @arg {} field
      * @returns value associated with field
+     * @example
+     * ```ts
+     * async function hGetExample(context: Devvit.Context) {
+     *  await context.redis.hSet("fruits", {"apple": "5", "orange": "7", "kiwi": "9"});
+     *  const result : string | undefined = await context.redis.hGet("fruits", "orange");
+     *  console.log("Value of orange: " + result);
+     * }
+     * ```
      */
     hGet(key: string, field: string): Promise<string | undefined>;
     /**
@@ -639,6 +1317,22 @@ export type RedisClient = {
      * https://redis.io/commands/hgetall
      * @arg {} key
      * @returns a map of fields and their values stored in the hash,
+     * @example
+     * ```
+     * async function hGetAllExample(context: Devvit.Context) {
+     *  await context.redis.hSet("groceryList", {
+     *   "eggs": "12",
+     *   "apples": "3",
+     *   "milk": "1"
+     *  });
+     *
+     *  const record : Record<string, string> | undefined = await context.redis.hGetAll("groceryList");
+     *
+     *  if (record != undefined) {
+     *   console.log("Eggs: " + record.eggs + ", Apples: " + record.apples + ", Milk: " + record.milk);
+     *  }
+     * }
+     * ```
      */
     hGetAll(key: string): Promise<Record<string, string> | undefined>;
     /**
@@ -656,6 +1350,14 @@ export type RedisClient = {
      * @arg {} key
      * @arg {} fields
      * @returns number of fields that were removed from the hash
+     * @example
+     * ```ts
+     * async function hDelExample(context: Devvit.Context) {
+     *  await context.redis.hSet("fruits", {"apple": "5", "orange": "7", "kiwi": "9"});
+     *  const numFieldsRemoved = await context.redis.hDel("fruits", ["apple", "kiwi"]);
+     *  console.log("Number of fields removed: " + numFieldsRemoved);
+     * }
+     * ```
      */
     hDel(key: string, fields: string[]): Promise<number>;
     /**
@@ -673,6 +1375,22 @@ export type RedisClient = {
      * @arg {} cursor
      * @arg {} pattern
      * @arg {} count
+     * @example
+     * ```ts
+     * async function hScanExample(context: Devvit.Context) {
+     *  await context.redis.hSet("userInfo", {
+     *    "name": "Bob",
+     *    "startDate": "01-05-20",
+     *    "totalAwards": "12"
+     *  });
+     *
+     *  const hScanResponse = await context.redis.hScan("userInfo", 0);
+     *
+     *  hScanResponse.fieldValues.forEach(x => {
+     *    console.log("Field: '" + x.field + "', Value: '" + x.value + "'");
+     *  });
+     * }
+     * ```
      */
     hScan(key: string, cursor: number, pattern?: string | undefined, count?: number | undefined): Promise<HScanResponse>;
     /**
@@ -684,6 +1402,18 @@ export type RedisClient = {
     /**
      * Returns all field names in the hash stored at key.
      * @arg {} key
+     * @example
+     * ```ts
+     * async function hKeysExample(context: Devvit.Context) {
+     *  await context.redis.hSet("prices", {
+     *    "chair": "48",
+     *    "desk": "95",
+     *    "whiteboard": "23"
+     *  });
+     *  const keys : string[] = await context.redis.hKeys("prices");
+     *  console.log("Keys: " + keys);
+     * }
+     * ```
      */
     hKeys(key: string): Promise<string[]>;
     /**
@@ -703,6 +1433,13 @@ export type RedisClient = {
      * @arg {} field
      * @arg {} value
      * @returns value of key after the increment
+     * @example
+     * ```ts
+     * async function hIncrByExample(context: Devvit.Context) {
+     *  await context.redis.hSet("user123", { "karma": "100" });
+     *  await context.redis.hIncrBy("user123", "karma", 5);
+     * }
+     * ```
      */
     hIncrBy(key: string, field: string, value: number): Promise<number>;
     /**
@@ -716,6 +1453,19 @@ export type RedisClient = {
      * Returns the number of fields contained in the hash stored at key.
      * @arg {} key
      * @returns the number of fields in the hash, or 0 when the key does not exist.
+     * @example
+     * ```ts
+     * async function hLenExample(context: Devvit.Context) {
+     *  await context.redis.hSet("supplies", {
+     *    "paperclips": "25",
+     *    "pencils": "10",
+     *    "erasers": "5",
+     *    "pens": "7"
+     *  });
+     *  const numberOfFields : number = await context.redis.hLen("supplies");
+     *  console.log("Number of fields: " + numberOfFields);
+     * }
+     * ```
      */
     hLen(key: string): Promise<number>;
     /**