@devvit/public-api 0.11.0-next-2024-07-25-e11c6b2a8.0 → 0.11.0-next-2024-07-25-3d6075a47.0

package/public-api.d.ts

@@ -46031,10 +46031,19 @@ export declare type RedisClient = {
      * Returns the length of the string value stored at key.
      * An error is returned when key holds a non-string value.
      * https://redis.io/commands/strlen/
+     * @deprecated Use {@link RedisClient.strLen} instead.
      * @arg {} key
      * @returns length of the string stored at key
      */
     strlen(key: string): Promise<number>;
+    /**
+     * Returns the length of the string value stored at key.
+     * An error is returned when key holds a non-string value.
+     * https://redis.io/commands/strlen/
+     * @arg {} key
+     * @returns length of the string stored at key
+     */
+    strLen(key: string): Promise<number>;
     /**
      * Increments the number stored at key by increment.
      * https://redis.io/commands/incrby/
@@ -46046,18 +46055,35 @@ export declare type RedisClient = {
     /**
      * Returns the values of all specified keys.
      * https://redis.io/commands/mget/
+     * @deprecated Use {@link RedisClient.mGet} instead.
      * @arg {} keys
      * @returns list of values at the specified keys
      */
     mget(keys: string[]): Promise<(string | null)[]>;
+    /**
+     * Returns the values of all specified keys.
+     * https://redis.io/commands/mget/
+     * @arg {} keys
+     * @returns list of values at the specified keys
+     */
+    mGet(keys: string[]): Promise<(string | null)[]>;
     /**
      * Sets the given keys to their respective values.
      * https://redis.io/commands/mset/
+     * @deprecated Use {@link RedisClient.mSet} instead.
      * @arg {} keyValues
      */
     mset(keyValues: {
         [key: string]: string;
     }): Promise<void>;
+    /**
+     * Sets the given keys to their respective values.
+     * https://redis.io/commands/mset/
+     * @arg {} keyValues
+     */
+    mSet(keyValues: {
+        [key: string]: string;
+    }): Promise<void>;
     /**
      * Set a timeout on key.
      * https://redis.io/commands/expire/
@@ -46172,6 +46198,7 @@ export declare type RedisClient = {
     /**
      * Sets the specified fields to their respective values in the hash stored at key.
      * https://redis.io/commands/hset
+     * @deprecated Use {@link RedisClient.hSet} instead.
      * @arg {} key
      * @arg {} fieldValues
      * @returns number of fields that were added
@@ -46179,42 +46206,93 @@ export declare type RedisClient = {
     hset(key: string, fieldValues: {
         [field: string]: string;
     }): Promise<number>;
+    /**
+     * Sets the specified fields to their respective values in the hash stored at key.
+     * https://redis.io/commands/hset
+     * @arg {} key
+     * @arg {} fieldValues
+     * @returns number of fields that were added
+     */
+    hSet(key: string, fieldValues: {
+        [field: string]: string;
+    }): Promise<number>;
     /**
      * Returns the value associated with field in the hash stored at key.
      * https://redis.io/commands/hget
+     * @deprecated Use {@link RedisClient.hGet} instead.
      * @arg {} key
      * @arg {} field
      * @returns value associated with field
      */
     hget(key: string, field: string): Promise<string | undefined>;
+    /**
+     * Returns the value associated with field in the hash stored at key.
+     * https://redis.io/commands/hget
+     * @arg {} key
+     * @arg {} field
+     * @returns value associated with field
+     */
+    hGet(key: string, field: string): Promise<string | undefined>;
     /**
      * Returns all fields and values of the hash stored at key
      * https://redis.io/commands/hgetall
+     * @deprecated Use {@link RedisClient.hGetAll} instead.
      * @arg {} key
      * @returns a map of fields and their values stored in the hash,
      */
     hgetall(key: string): Promise<Record<string, string> | undefined>;
+    /**
+     * Returns all fields and values of the hash stored at key
+     * https://redis.io/commands/hgetall
+     * @arg {} key
+     * @returns a map of fields and their values stored in the hash,
+     */
+    hGetAll(key: string): Promise<Record<string, string> | undefined>;
     /**
      * Removes the specified fields from the hash stored at key.
      * https://redis.io/commands/hdel/
+     * @deprecated Use {@link RedisClient.hDel} instead.
      * @arg {} key
      * @arg {} fields
      * @returns number of fields that were removed from the hash
      */
     hdel(key: string, fields: string[]): Promise<number>;
+    /**
+     * Removes the specified fields from the hash stored at key.
+     * https://redis.io/commands/hdel/
+     * @arg {} key
+     * @arg {} fields
+     * @returns number of fields that were removed from the hash
+     */
+    hDel(key: string, fields: string[]): Promise<number>;
     /**
      * Iterates fields of Hash types and their associated values.
+     * @deprecated Use {@link RedisClient.hScan} instead.
      * @arg {} key
      * @arg {} cursor
      * @arg {} pattern
      * @arg {} count
      */
     hscan(key: string, cursor: number, pattern?: string | undefined, count?: number | undefined): Promise<HScanResponse>;
+    /**
+     * Iterates fields of Hash types and their associated values.
+     * @arg {} key
+     * @arg {} cursor
+     * @arg {} pattern
+     * @arg {} count
+     */
+    hScan(key: string, cursor: number, pattern?: string | undefined, count?: number | undefined): Promise<HScanResponse>;
     /**
      * Returns all field names in the hash stored at key.
+     * @deprecated Use {@link RedisClient.hKeys} instead.
      * @arg {} key
      */
     hkeys(key: string): Promise<string[]>;
+    /**
+     * Returns all field names in the hash stored at key.
+     * @arg {} key
+     */
+    hKeys(key: string): Promise<string[]>;
     /**
      * Increments the number stored at field in the hash stored at key by increment.
      * https://redis.io/commands/hincrby/
@@ -46224,12 +46302,29 @@ export declare type RedisClient = {
      * @returns value of key after the increment
      */
     hincrby(key: string, field: string, value: number): Promise<number>;
+    /**
+     * Increments the number stored at field in the hash stored at key by increment.
+     * https://redis.io/commands/hincrby/
+     * @deprecated Use {@link RedisClient.hIncrBy} instead.
+     * @arg {} key
+     * @arg {} field
+     * @arg {} value
+     * @returns value of key after the increment
+     */
+    hIncrBy(key: string, field: string, value: number): Promise<number>;
     /**
      * Returns the number of fields contained in the hash stored at key.
+     * @deprecated Use {@link RedisClient.hLen} instead.
      * @arg {} key
      * @returns the number of fields in the hash, or 0 when the key does not exist.
      */
     hlen(key: string): Promise<number>;
+    /**
+     * 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.
+     */
+    hLen(key: string): Promise<number>;
     /**
      * Allows read/write operations to global keys in Redis
      * Global redis enables apps to persist and access state across subreddit installations
@@ -66171,25 +66266,51 @@ export declare type TxClientLike = {
      * Returns the length of the string value stored at key.
      * An error is returned when key holds a non-string value.
      * https://redis.io/commands/strlen/
+     * @deprecated Use {@link TxClientLike.strLen} instead.
      * @arg {} key
      * @returns length of the string stored at key
      */
     strlen(key: string): Promise<TxClientLike>;
+    /**
+     * Returns the length of the string value stored at key.
+     * An error is returned when key holds a non-string value.
+     * https://redis.io/commands/strlen/
+     * @arg {} key
+     * @returns length of the string stored at key
+     */
+    strLen(key: string): Promise<TxClientLike>;
     /**
      * Returns the values of all specified keys.
      * https://redis.io/commands/mget/
+     * @deprecated Use {@link TxClientLike.mGet} instead.
      * @arg {} keys
      * @returns list of values at the specified keys
      */
     mget(keys: string[]): Promise<TxClientLike>;
+    /**
+     * Returns the values of all specified keys.
+     * https://redis.io/commands/mget/
+     * @arg {} keys
+     * @returns list of values at the specified keys
+     */
+    mGet(keys: string[]): Promise<TxClientLike>;
     /**
      * Sets the given keys to their respective values.
      * https://redis.io/commands/mset/
+     * @deprecated Use {@link TxClientLike.mSet} instead.
      * @arg {} keyValues
      */
     mset(keyValues: {
         [key: string]: string;
     }): Promise<TxClientLike>;
+    /**
+     * Sets the given keys to their respective values.
+     * https://redis.io/commands/mset/
+     * @arg {} keyValues
+     */
+    mSet(keyValues: {
+        [key: string]: string;
+    }): Promise<TxClientLike>;
     /**
      * Set a timeout on key.
      * https://redis.io/commands/expire/
@@ -66301,6 +66422,7 @@ export declare type TxClientLike = {
     /**
      * Sets the specified fields to their respective values in the hash stored at key.
      * https://redis.io/commands/hset
+     * @deprecated Use {@link TxClientLike.hSet} instead.
      * @arg {} key
      * @arg {} fieldValues
      * @returns number of fields that were added
@@ -66308,57 +66430,125 @@ export declare type TxClientLike = {
     hset(key: string, fieldValues: {
         [field: string]: string;
     }): Promise<TxClientLike>;
+    /**
+     * Sets the specified fields to their respective values in the hash stored at key.
+     * https://redis.io/commands/hset
+     * @arg {} key
+     * @arg {} fieldValues
+     * @returns number of fields that were added
+     */
+    hSet(key: string, fieldValues: {
+        [field: string]: string;
+    }): Promise<TxClientLike>;
     /**
      * Returns the value associated with field in the hash stored at key.
      * https://redis.io/commands/hget
+     * @deprecated Use {@link TxClientLike.hGet} instead.
      * @arg {} key
      * @arg {} field
      * @returns value associated with field
      */
     hget(key: string, field: string): Promise<TxClientLike>;
+    /**
+     * Returns the value associated with field in the hash stored at key.
+     * https://redis.io/commands/hget
+     * @arg {} key
+     * @arg {} field
+     * @returns value associated with field
+     */
+    hGet(key: string, field: string): Promise<TxClientLike>;
     /**
      * Returns all fields and values of the hash stored at key
      * https://redis.io/commands/hgetall
+     * @deprecated Use {@link TxClientLike.hGetAll} instead.
      * @arg {} key
      * @returns a map of fields and their values stored in the hash,
      */
     hgetall(key: string): Promise<TxClientLike>;
+    /**
+     * Returns all fields and values of the hash stored at key
+     * https://redis.io/commands/hgetall
+     * @arg {} key
+     * @returns a map of fields and their values stored in the hash,
+     */
+    hGetAll(key: string): Promise<TxClientLike>;
     /**
      * Removes the specified fields from the hash stored at key.
      * https://redis.io/commands/hdel/
+     * @deprecated Use {@link TxClientLike.hDel} instead.
      * @arg {} key
      * @arg {} fields
      * @returns number of fields that were removed from the hash
      */
     hdel(key: string, fields: string[]): Promise<TxClientLike>;
+    /**
+     * Removes the specified fields from the hash stored at key.
+     * https://redis.io/commands/hdel/
+     * @arg {} key
+     * @arg {} fields
+     * @returns number of fields that were removed from the hash
+     */
+    hDel(key: string, fields: string[]): Promise<TxClientLike>;
     /**
      * Iterates fields of Hash types and their associated values.
+     * @deprecated Use {@link TxClientLike.hScan} instead.
      * @arg {} key
      * @arg {} cursor
      * @arg {} pattern
      * @arg {} count
      */
     hscan(key: string, cursor: number, pattern?: string | undefined, count?: number | undefined): Promise<TxClientLike>;
+    /**
+     * Iterates fields of Hash types and their associated values.
+     * @arg {} key
+     * @arg {} cursor
+     * @arg {} pattern
+     * @arg {} count
+     */
+    hScan(key: string, cursor: number, pattern?: string | undefined, count?: number | undefined): Promise<TxClientLike>;
     /**
      * Returns all field names in the hash stored at key.
+     * @deprecated Use {@link TxClientLike.hKeys} instead.
      * @arg {} key
      */
     hkeys(key: string): Promise<TxClientLike>;
+    /**
+     * Returns all field names in the hash stored at key.
+     * @arg {} key
+     */
+    hKeys(key: string): Promise<TxClientLike>;
     /**
      * Increments the number stored at field in the hash stored at key by increment.
      * https://redis.io/commands/hincrby/
+     * @deprecated Use {@link TxClientLike.hIncrBy} instead.
      * @arg {} key
      * @arg {} field
      * @arg {} value
      * @returns value of key after the increment
      */
     hincrby(key: string, field: string, value: number): Promise<TxClientLike>;
+    /**
+     * Increments the number stored at field in the hash stored at key by increment.
+     * https://redis.io/commands/hincrby/
+     * @arg {} key
+     * @arg {} field
+     * @arg {} value
+     * @returns value of key after the increment
+     */
+    hIncrBy(key: string, field: string, value: number): Promise<TxClientLike>;
     /**
      * Returns the number of fields contained in the hash stored at key.
+     * @deprecated Use {@link TxClientLike.hLen} instead.
      * @arg {} key
      * @returns the number of fields in the hash, or 0 when the key does not exist.
      */
     hlen(key: string): Promise<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.
+     */
+    hLen(key: string): Promise<TxClientLike>;
 };
 
 /**