diff --git a/node/src/BaseClient.ts b/node/src/BaseClient.ts index 51e9c578ce..b43e37e50d 100644 --- a/node/src/BaseClient.ts +++ b/node/src/BaseClient.ts @@ -299,12 +299,12 @@ class PointerResponse { /** Represents the credentials for connecting to a server. */ export type RedisCredentials = { /** - * The username that will be used for authenticating connections to the Redis servers. + * The username that will be used for authenticating connections to the Valkey servers. * If not supplied, "default" will be used. */ username?: string; /** - * The password that will be used for authenticating connections to the Redis servers. + * The password that will be used for authenticating connections to the Valkey servers. */ password: string; }; @@ -919,7 +919,8 @@ export class BaseClient { } /** Get the value associated with the given key, or null if no such value exists. - * See https://valkey.io/commands/get/ for details. + * + * @see {@link https://valkey.io/commands/get/|valkey.io} for details. * * @param key - The key to retrieve from the database. * @param decoder - (Optional) {@link Decoder} type which defines how to handle the response. If not set, the default decoder from the client config will be used. @@ -945,7 +946,8 @@ export class BaseClient { /** * Get the value of `key` and optionally set its expiration. `GETEX` is similar to {@link get}. * - * See https://valkey.io/commands/getex for more details. + * @see {@link https://valkey.io/commands/getex/|valkey.op} for more details. + * @remarks Since Valkey version 6.2.0. * * @param key - The key to retrieve from the database. * @param options - (Optional) Set expiriation to the given key. @@ -953,8 +955,6 @@ export class BaseClient { * Otherwise, a {@link TimeUnit} and duration of the expire time should be specified. * @returns If `key` exists, returns the value of `key` as a `string`. Otherwise, return `null`. * - * since - Valkey 6.2.0 and above. - * * @example * ```typescript * const result = await client.getex("key", {expiry: { type: TimeUnit.Seconds, count: 5 }}); @@ -971,7 +971,7 @@ export class BaseClient { /** * Gets a string value associated with the given `key`and deletes the key. * - * See https://valkey.io/commands/getdel/ for details. + * @see {@link https://valkey.io/commands/getdel/|valkey.io} for details. * * @param key - The key to retrieve from the database. * @param decoder - (Optional) {@link Decoder} type which defines how to handle the response. If not set, the default decoder from the client config will be used. @@ -999,7 +999,7 @@ export class BaseClient { * penultimate and so forth. If `key` does not exist, an empty string is returned. If `start` * or `end` are out of range, returns the substring within the valid range of the string. * - * See https://valkey.io/commands/getrange/ for details. + * @see {@link https://valkey.io/commands/getrange/|valkey.io} for details. * * @param key - The key of the string. * @param start - The starting offset. @@ -1028,7 +1028,8 @@ export class BaseClient { } /** Set the given key with the given value. Return value is dependent on the passed options. - * See https://valkey.io/commands/set/ for details. + * + * @see {@link https://valkey.io/commands/set/|valkey.io} for details. * * @param key - The key to store. * @param value - The value to store with the given key. @@ -1065,7 +1066,8 @@ export class BaseClient { } /** Removes the specified keys. A key is ignored if it does not exist. - * See https://valkey.io/commands/del/ for details. + * + * @see {@link https://valkey.io/commands/del/|valkey.io} for details. * * @param keys - the keys we wanted to remove. * @returns the number of keys that were removed. @@ -1090,9 +1092,10 @@ export class BaseClient { } /** Retrieve the values of multiple keys. - * See https://valkey.io/commands/mget/ for details. * + * @see {@link https://valkey.io/commands/mget/|valkey.io} for details. * @remarks When in cluster mode, the command may route to multiple nodes when `keys` map to different hash slots. + * * @param keys - A list of keys to retrieve values for. * @returns A list of values corresponding to the provided keys. If a key is not found, * its corresponding value in the list will be null. @@ -1111,9 +1114,10 @@ export class BaseClient { } /** Set multiple keys to multiple values in a single operation. - * See https://valkey.io/commands/mset/ for details. * + * @see {@link https://valkey.io/commands/mset/|valkey.io} for details. * @remarks When in cluster mode, the command may route to multiple nodes when keys in `keyValueMap` map to different hash slots. + * * @param keyValueMap - A key-value map consisting of keys and their respective values to set. * @returns always "OK". * @@ -1132,9 +1136,9 @@ export class BaseClient { * Sets multiple keys to values if the key does not exist. The operation is atomic, and if one or * more keys already exist, the entire operation fails. * - * See https://valkey.io/commands/msetnx/ for more details. - * + * @see {@link https://valkey.io/commands/msetnx/|valkey.io} for more details. * @remarks When in cluster mode, all keys in `keyValueMap` must map to the same hash slot. + * * @param keyValueMap - A key-value map consisting of keys and their respective values to set. * @returns `true` if all keys were set. `false` if no key was set. * @@ -1152,7 +1156,8 @@ export class BaseClient { } /** Increments the number stored at `key` by one. If `key` does not exist, it is set to 0 before performing the operation. - * See https://valkey.io/commands/incr/ for details. + * + * @see {@link https://valkey.io/commands/incr/|valkey.io} for details. * * @param key - The key to increment its value. * @returns the value of `key` after the increment. @@ -1170,7 +1175,8 @@ export class BaseClient { } /** Increments the number stored at `key` by `amount`. If `key` does not exist, it is set to 0 before performing the operation. - * See https://valkey.io/commands/incrby/ for details. + * + * @see {@link https://valkey.io/commands/incrby/|valkey.io} for details. * * @param key - The key to increment its value. * @param amount - The amount to increment. @@ -1191,7 +1197,8 @@ export class BaseClient { /** Increment the string representing a floating point number stored at `key` by `amount`. * By using a negative increment value, the result is that the value stored at `key` is decremented. * If `key` does not exist, it is set to 0 before performing the operation. - * See https://valkey.io/commands/incrbyfloat/ for details. + * + * @see {@link https://valkey.io/commands/incrbyfloat/|valkey.io} for details. * * @param key - The key to increment its value. * @param amount - The amount to increment. @@ -1210,7 +1217,8 @@ export class BaseClient { } /** Decrements the number stored at `key` by one. If `key` does not exist, it is set to 0 before performing the operation. - * See https://valkey.io/commands/decr/ for details. + * + * @see {@link https://valkey.io/commands/decr/|valkey.io} for details. * * @param key - The key to decrement its value. * @returns the value of `key` after the decrement. @@ -1228,7 +1236,8 @@ export class BaseClient { } /** Decrements the number stored at `key` by `amount`. If `key` does not exist, it is set to 0 before performing the operation. - * See https://valkey.io/commands/decrby/ for details. + * + * @see {@link https://valkey.io/commands/decrby/|valkey.io} for details. * * @param key - The key to decrement its value. * @param amount - The amount to decrement. @@ -1250,9 +1259,9 @@ export class BaseClient { * Perform a bitwise operation between multiple keys (containing string values) and store the result in the * `destination`. * - * See https://valkey.io/commands/bitop/ for more details. - * + * @see {@link https://valkey.io/commands/bitop/|valkey.io} for more details. * @remarks When in cluster mode, `destination` and all `keys` must map to the same hash slot. + * * @param operation - The bitwise operation to perform. * @param destination - The key that will store the resulting string. * @param keys - The list of keys to perform the bitwise operation on. @@ -1283,7 +1292,7 @@ export class BaseClient { * Returns the bit value at `offset` in the string value stored at `key`. `offset` must be greater than or equal * to zero. * - * See https://valkey.io/commands/getbit/ for more details. + * @see {@link https://valkey.io/commands/getbit/|valkey.io} for more details. * * @param key - The key of the string. * @param offset - The index of the bit to return. @@ -1306,7 +1315,7 @@ export class BaseClient { * `2^32` and greater than or equal to `0`. If a key is non-existent then the bit at `offset` is set to `value` and * the preceding bits are set to `0`. * - * See https://valkey.io/commands/setbit/ for more details. + * @see {@link https://valkey.io/commands/setbit/|valkey.io} for more details. * * @param key - The key of the string. * @param offset - The index of the bit to be set. @@ -1333,7 +1342,7 @@ export class BaseClient { * The offset can also be a negative number indicating an offset starting at the end of the list, with `-1` being * the last byte of the list, `-2` being the penultimate, and so on. * - * See https://valkey.io/commands/bitpos/ for more details. + * @see {@link https://valkey.io/commands/bitpos/|valkey.io} for more details. * * @param key - The key of the string. * @param bit - The bit value to match. Must be `0` or `1`. @@ -1370,7 +1379,7 @@ export class BaseClient { * are assumed. If BIT is specified, `start=0` and `end=2` means to look at the first three bits. If BYTE is * specified, `start=0` and `end=2` means to look at the first three bytes. * - * See https://valkey.io/commands/bitpos/ for more details. + * @see {@link https://valkey.io/commands/bitpos/|valkey.io} for more details. * * @param key - The key of the string. * @param bit - The bit value to match. Must be `0` or `1`. @@ -1408,7 +1417,7 @@ export class BaseClient { * Reads or modifies the array of bits representing the string that is held at `key` based on the specified * `subcommands`. * - * See https://valkey.io/commands/bitfield/ for more details. + * @see {@link https://valkey.io/commands/bitfield/|valkey.io} for more details. * * @param key - The key of the string. * @param subcommands - The subcommands to be performed on the binary value of the string at `key`, which could be @@ -1445,14 +1454,13 @@ export class BaseClient { /** * Reads the array of bits representing the string that is held at `key` based on the specified `subcommands`. * - * See https://valkey.io/commands/bitfield_ro/ for more details. + * @see {@link https://valkey.io/commands/bitfield_ro/|valkey.io} for more details. + * @remarks Since Valkey version 6.0.0. * * @param key - The key of the string. * @param subcommands - The {@link BitFieldGet} subcommands to be performed. * @returns An array of results from the {@link BitFieldGet} subcommands. * - * since Valkey version 6.0.0. - * * @example * ```typescript * await client.set("key", "A"); // "A" has binary value 01000001 @@ -1468,7 +1476,8 @@ export class BaseClient { } /** Retrieve the value associated with `field` in the hash stored at `key`. - * See https://valkey.io/commands/hget/ for details. + * + * @see {@link https://valkey.io/commands/hget/|valkey.io} for details. * * @param key - The key of the hash. * @param field - The field in the hash stored at `key` to retrieve from the database. @@ -1494,7 +1503,8 @@ export class BaseClient { } /** Sets the specified fields to their respective values in the hash stored at `key`. - * See https://valkey.io/commands/hset/ for details. + * + * @see {@link https://valkey.io/commands/hset/|valkey.io} for details. * * @param key - The key of the hash. * @param fieldValueMap - A field-value map consisting of fields and their corresponding values @@ -1518,7 +1528,8 @@ export class BaseClient { /** Sets `field` in the hash stored at `key` to `value`, only if `field` does not yet exist. * If `key` does not exist, a new key holding a hash is created. * If `field` already exists, this operation has no effect. - * See https://valkey.io/commands/hsetnx/ for more details. + * + * @see {@link https://valkey.io/commands/hsetnx/|valkey.io} for more details. * * @param key - The key of the hash. * @param field - The field to set the value for. @@ -1549,7 +1560,8 @@ export class BaseClient { /** Removes the specified fields from the hash stored at `key`. * Specified fields that do not exist within this hash are ignored. - * See https://valkey.io/commands/hdel/ for details. + * + * @see {@link https://valkey.io/commands/hdel/|valkey.io} for details. * * @param key - The key of the hash. * @param fields - The fields to remove from the hash stored at `key`. @@ -1568,7 +1580,8 @@ export class BaseClient { } /** Returns the values associated with the specified fields in the hash stored at `key`. - * See https://valkey.io/commands/hmget/ for details. + * + * @see {@link https://valkey.io/commands/hmget/|valkey.io} for details. * * @param key - The key of the hash. * @param fields - The fields in the hash stored at `key` to retrieve from the database. @@ -1591,7 +1604,8 @@ export class BaseClient { } /** Returns if `field` is an existing field in the hash stored at `key`. - * See https://valkey.io/commands/hexists/ for details. + * + * @see {@link https://valkey.io/commands/hexists/|valkey.io} for details. * * @param key - The key of the hash. * @param field - The field to check in the hash stored at `key`. @@ -1616,7 +1630,8 @@ export class BaseClient { } /** Returns all fields and values of the hash stored at `key`. - * See https://valkey.io/commands/hgetall/ for details. + * + * @see {@link https://valkey.io/commands/hgetall/|valkey.io} for details. * * @param key - The key of the hash. * @returns a list of fields and their values stored in the hash. Every field name in the list is followed by its value. @@ -1636,7 +1651,8 @@ export class BaseClient { /** Increments the number stored at `field` in the hash stored at `key` by increment. * By using a negative increment value, the value stored at `field` in the hash stored at `key` is decremented. * If `field` or `key` does not exist, it is set to 0 before performing the operation. - * See https://valkey.io/commands/hincrby/ for details. + * + * @see {@link https://valkey.io/commands/hincrby/|valkey.io} for details. * * @param key - The key of the hash. * @param amount - The amount to increment. @@ -1661,7 +1677,8 @@ export class BaseClient { /** Increment the string representing a floating point number stored at `field` in the hash stored at `key` by increment. * By using a negative increment value, the value stored at `field` in the hash stored at `key` is decremented. * If `field` or `key` does not exist, it is set to 0 before performing the operation. - * See https://valkey.io/commands/hincrbyfloat/ for details. + * + * @see {@link https://valkey.io/commands/hincrbyfloat/|valkey.io} for details. * * @param key - The key of the hash. * @param amount - The amount to increment. @@ -1684,7 +1701,8 @@ export class BaseClient { } /** Returns the number of fields contained in the hash stored at `key`. - * See https://valkey.io/commands/hlen/ for more details. + * + * @see {@link https://valkey.io/commands/hlen/|valkey.io} for more details. * * @param key - The key of the hash. * @returns The number of fields in the hash, or 0 when the key does not exist. @@ -1708,7 +1726,8 @@ export class BaseClient { } /** Returns all values in the hash stored at key. - * See https://valkey.io/commands/hvals/ for more details. + * + * @see {@link https://valkey.io/commands/hvals/|valkey.io} for more details. * * @param key - The key of the hash. * @returns a list of values in the hash, or an empty list when the key does not exist. @@ -1727,7 +1746,7 @@ export class BaseClient { /** * Returns the string length of the value associated with `field` in the hash stored at `key`. * - * See https://valkey.io/commands/hstrlen/ for details. + * @see {@link https://valkey.io/commands/hstrlen/|valkey.io} for details. * * @param key - The key of the hash. * @param field - The field in the hash. @@ -1747,9 +1766,8 @@ export class BaseClient { /** * Returns a random field name from the hash value stored at `key`. * - * See https://valkey.io/commands/hrandfield/ for more details. - * - * since Valkey version 6.2.0. + * @see {@link https://valkey.io/commands/hrandfield/|valkey.io} for more details. + * @remarks Since Valkey version 6.2.0. * * @param key - The key of the hash. * @returns A random field name from the hash stored at `key`, or `null` when @@ -1767,7 +1785,7 @@ export class BaseClient { /** * Iterates incrementally over a hash. * - * See https://valkey.io/commands/hscan for more details. + * @see {@link https://valkey.io/commands/hscan/|valkey.io} for more details. * * @param key - The key of the set. * @param cursor - The cursor that points to the next iteration of results. A value of `"0"` indicates the start of the search. @@ -1812,9 +1830,8 @@ export class BaseClient { /** * Retrieves up to `count` random field names from the hash value stored at `key`. * - * See https://valkey.io/commands/hrandfield/ for more details. - * - * since Valkey version 6.2.0. + * @see {@link https://valkey.io/commands/hrandfield/|valkey.io} for more details. + * @remarks Since Valkey version 6.2.0. * * @param key - The key of the hash. * @param count - The number of field names to return. @@ -1839,9 +1856,8 @@ export class BaseClient { * Retrieves up to `count` random field names along with their values from the hash * value stored at `key`. * - * See https://valkey.io/commands/hrandfield/ for more details. - * - * since Valkey version 6.2.0. + * @see {@link https://valkey.io/commands/hrandfield/|valkey.io} for more details. + * @remarks Since Valkey version 6.2.0. * * @param key - The key of the hash. * @param count - The number of field names to return. @@ -1867,7 +1883,8 @@ export class BaseClient { /** Inserts all the specified values at the head of the list stored at `key`. * `elements` are inserted one after the other to the head of the list, from the leftmost element to the rightmost element. * If `key` does not exist, it is created as empty list before performing the push operations. - * See https://valkey.io/commands/lpush/ for details. + * + * @see {@link https://valkey.io/commands/lpush/|valkey.io} for details. * * @param key - The key of the list. * @param elements - The elements to insert at the head of the list stored at `key`. @@ -1895,7 +1912,7 @@ export class BaseClient { * Inserts specified values at the head of the `list`, only if `key` already * exists and holds a list. * - * See https://valkey.io/commands/lpushx/ for details. + * @see {@link https://valkey.io/commands/lpushx/|valkey.io} for details. * * @param key - The key of the list. * @param elements - The elements to insert at the head of the list stored at `key`. @@ -1912,7 +1929,8 @@ export class BaseClient { /** Removes and returns the first elements of the list stored at `key`. * The command pops a single element from the beginning of the list. - * See https://valkey.io/commands/lpop/ for details. + * + * @see {@link https://valkey.io/commands/lpop/|valkey.io} for details. * * @param key - The key of the list. * @returns The value of the first element. @@ -1937,7 +1955,8 @@ export class BaseClient { } /** Removes and returns up to `count` elements of the list stored at `key`, depending on the list's length. - * See https://valkey.io/commands/lpop/ for details. + * + * @see {@link https://valkey.io/commands/lpop/|valkey.io} for details. * * @param key - The key of the list. * @param count - The count of the elements to pop from the list. @@ -1969,7 +1988,8 @@ export class BaseClient { * The offsets `start` and `end` are zero-based indexes, with 0 being the first element of the list, 1 being the next element and so on. * These offsets can also be negative numbers indicating offsets starting at the end of the list, * with -1 being the last element of the list, -2 being the penultimate, and so on. - * See https://valkey.io/commands/lrange/ for details. + * + * @see {@link https://valkey.io/commands/lrange/|valkey.io} for details. * * @param key - The key of the list. * @param start - The starting point of the range. @@ -2009,7 +2029,8 @@ export class BaseClient { } /** Returns the length of the list stored at `key`. - * See https://valkey.io/commands/llen/ for details. + * + * @see {@link https://valkey.io/commands/llen/|valkey.io} for details. * * @param key - The key of the list. * @returns the length of the list at `key`. @@ -2031,7 +2052,8 @@ export class BaseClient { * depending on `whereTo`, and pushes the element at the first/last element of the list * stored at `destination` depending on `whereFrom`, see {@link ListDirection}. * - * See https://valkey.io/commands/lmove/ for details. + * @see {@link https://valkey.io/commands/lmove/|valkey.io} for details. + * @remarks Since Valkey version 6.2.0. * * @param source - The key to the source list. * @param destination - The key to the destination list. @@ -2039,8 +2061,6 @@ export class BaseClient { * @param whereTo - The {@link ListDirection} to add the element to. * @returns The popped element, or `null` if `source` does not exist. * - * since Valkey version 6.2.0. - * * @example * ```typescript * await client.lpush("testKey1", ["two", "one"]); @@ -2073,11 +2093,10 @@ export class BaseClient { * of the list stored at `destination` depending on `whereTo`. * `BLMOVE` is the blocking variant of {@link lmove}. * - * @remarks - * 1. When in cluster mode, both `source` and `destination` must map to the same hash slot. - * 2. `BLMOVE` is a client blocking command, see https://github.com/aws/glide-for-redis/wiki/General-Concepts#blocking-commands for more details and best practices. - * - * See https://valkey.io/commands/blmove/ for details. + * @see {@link https://valkey.io/commands/blmove/|valkey.io} for details. + * @remarks When in cluster mode, both `source` and `destination` must map to the same hash slot. + * @remarks `BLMOVE` is a client blocking command, see {@link https://github.com/valkey-io/valkey-glide/wiki/General-Concepts#blocking-commands|Valkey Glide Wiki} for more details and best practices. + * @remarks Since Valkey version 6.2.0. * * @param source - The key to the source list. * @param destination - The key to the destination list. @@ -2086,8 +2105,6 @@ export class BaseClient { * @param timeout - The number of seconds to wait for a blocking operation to complete. A value of `0` will block indefinitely. * @returns The popped element, or `null` if `source` does not exist or if the operation timed-out. * - * since Valkey version 6.2.0. - * * @example * ```typescript * await client.lpush("testKey1", ["two", "one"]); @@ -2120,7 +2137,7 @@ export class BaseClient { * Negative indices can be used to designate elements starting at the tail of * the list. Here, `-1` means the last element, `-2` means the penultimate and so forth. * - * See https://valkey.io/commands/lset/ for details. + * @see {@link https://valkey.io/commands/lset/|valkey.io} for details. * * @param key - The key of the list. * @param index - The index of the element in the list to be set. @@ -2146,7 +2163,8 @@ export class BaseClient { * The offsets `start` and `end` are zero-based indexes, with 0 being the first element of the list, 1 being the next element and so on. * These offsets can also be negative numbers indicating offsets starting at the end of the list, * with -1 being the last element of the list, -2 being the penultimate, and so on. - * See https://valkey.io/commands/ltrim/ for details. + * + * @see {@link https://valkey.io/commands/ltrim/|valkey.io} for details. * * @param key - The key of the list. * @param start - The starting point of the range. @@ -2196,7 +2214,8 @@ export class BaseClient { /** Inserts all the specified values at the tail of the list stored at `key`. * `elements` are inserted one after the other to the tail of the list, from the leftmost element to the rightmost element. * If `key` does not exist, it is created as empty list before performing the push operations. - * See https://valkey.io/commands/rpush/ for details. + * + * @see {@link https://valkey.io/commands/rpush/|valkey.io} for details. * * @param key - The key of the list. * @param elements - The elements to insert at the tail of the list stored at `key`. @@ -2224,7 +2243,7 @@ export class BaseClient { * Inserts specified values at the tail of the `list`, only if `key` already * exists and holds a list. * - * See https://valkey.io/commands/rpushx/ for details. + * @see {@link https://valkey.io/commands/rpushx/|valkey.io} for details. * * @param key - The key of the list. * @param elements - The elements to insert at the tail of the list stored at `key`. @@ -2241,7 +2260,8 @@ export class BaseClient { /** Removes and returns the last elements of the list stored at `key`. * The command pops a single element from the end of the list. - * See https://valkey.io/commands/rpop/ for details. + * + * @see {@link https://valkey.io/commands/rpop/|valkey.io} for details. * * @param key - The key of the list. * @returns The value of the last element. @@ -2266,7 +2286,8 @@ export class BaseClient { } /** Removes and returns up to `count` elements from the list stored at `key`, depending on the list's length. - * See https://valkey.io/commands/rpop/ for details. + * + * @see {@link https://valkey.io/commands/rpop/|valkey.io} for details. * * @param key - The key of the list. * @param count - The count of the elements to pop from the list. @@ -2296,7 +2317,8 @@ export class BaseClient { /** Adds the specified members to the set stored at `key`. Specified members that are already a member of this set are ignored. * If `key` does not exist, a new set is created before adding `members`. - * See https://valkey.io/commands/sadd/ for details. + * + * @see {@link https://valkey.io/commands/sadd/|valkey.io} for details. * * @param key - The key to store the members to its set. * @param members - A list of members to add to the set stored at `key`. @@ -2314,7 +2336,8 @@ export class BaseClient { } /** Removes the specified members from the set stored at `key`. Specified members that are not a member of this set are ignored. - * See https://valkey.io/commands/srem/ for details. + * + * @see {@link https://valkey.io/commands/srem/|valkey.io} for details. * * @param key - The key to remove the members from its set. * @param members - A list of members to remove from the set stored at `key`. @@ -2333,7 +2356,8 @@ export class BaseClient { } /** Returns all the members of the set value stored at `key`. - * See https://valkey.io/commands/smembers/ for details. + * + * @see {@link https://valkey.io/commands/smembers/|valkey.io} for details. * * @param key - The key to return its members. * @returns A `Set` containing all members of the set. @@ -2354,8 +2378,8 @@ export class BaseClient { /** Moves `member` from the set at `source` to the set at `destination`, removing it from the source set. * Creates a new destination set if needed. The operation is atomic. - * See https://valkey.io/commands/smove for more details. * + * @see {@link https://valkey.io/commands/smove/|valkey.io} for more details. * @remarks When in cluster mode, `source` and `destination` must map to the same hash slot. * * @param source - The key of the set to remove the element from. @@ -2380,7 +2404,8 @@ export class BaseClient { } /** Returns the set cardinality (number of elements) of the set stored at `key`. - * See https://valkey.io/commands/scard/ for details. + * + * @see {@link https://valkey.io/commands/scard/|valkey.io} for details. * * @param key - The key to return the number of its members. * @returns The cardinality (number of elements) of the set, or 0 if key does not exist. @@ -2397,9 +2422,10 @@ export class BaseClient { } /** Gets the intersection of all the given sets. - * See https://valkey.io/docs/latest/commands/sinter/ for more details. * + * @see {@link https://valkey.io/docs/latest/commands/sinter/|valkey.io} for more details. * @remarks When in cluster mode, all `keys` must map to the same hash slot. + * * @param keys - The `keys` of the sets to get the intersection. * @returns - A set of members which are present in all given sets. * If one or more sets do not exist, an empty set will be returned. @@ -2427,15 +2453,14 @@ export class BaseClient { /** * Gets the cardinality of the intersection of all the given sets. * - * See https://valkey.io/commands/sintercard/ for more details. - * + * @see {@link https://valkey.io/commands/sintercard/|valkey.io} for more details. * @remarks When in cluster mode, all `keys` must map to the same hash slot. + * @remarks Since Valkey version 7.0.0. + * * @param keys - The keys of the sets. * @param limit - The limit for the intersection cardinality value. If not specified, or set to `0`, no limit is used. * @returns The cardinality of the intersection result. If one or more sets do not exist, `0` is returned. * - * since Valkey version 7.0.0. - * * @example * ```typescript * await client.sadd("set1", ["a", "b", "c"]); @@ -2454,9 +2479,9 @@ export class BaseClient { /** * Stores the members of the intersection of all given sets specified by `keys` into a new set at `destination`. * - * See https://valkey.io/commands/sinterstore/ for more details. - * + * @see {@link https://valkey.io/commands/sinterstore/|valkey.io} for more details. * @remarks When in cluster mode, `destination` and all `keys` must map to the same hash slot. + * * @param destination - The key of the destination set. * @param keys - The keys from which to retrieve the set members. * @returns The number of elements in the resulting set. @@ -2477,9 +2502,9 @@ export class BaseClient { /** * Computes the difference between the first set and all the successive sets in `keys`. * - * See https://valkey.io/commands/sdiff/ for more details. - * + * @see {@link https://valkey.io/commands/sdiff/|valkey.io} for more details. * @remarks When in cluster mode, all `keys` must map to the same hash slot. + * * @param keys - The keys of the sets to diff. * @returns A `Set` of elements representing the difference between the sets. * If a key in `keys` does not exist, it is treated as an empty set. @@ -2501,9 +2526,9 @@ export class BaseClient { /** * Stores the difference between the first set and all the successive sets in `keys` into a new set at `destination`. * - * See https://valkey.io/commands/sdiffstore/ for more details. - * + * @see {@link https://valkey.io/commands/sdiffstore/|valkey.io} for more details. * @remarks When in cluster mode, `destination` and all `keys` must map to the same hash slot. + * * @param destination - The key of the destination set. * @param keys - The keys of the sets to diff. * @returns The number of elements in the resulting set. @@ -2526,9 +2551,9 @@ export class BaseClient { /** * Gets the union of all the given sets. * - * See https://valkey.io/commands/sunion/ for more details. - * + * @see {@link https://valkey.io/commands/sunion/|valkey.io} for more details. * @remarks When in cluster mode, all `keys` must map to the same hash slot. + * * @param keys - The keys of the sets. * @returns A `Set` of members which are present in at least one of the given sets. * If none of the sets exist, an empty `Set` will be returned. @@ -2554,9 +2579,9 @@ export class BaseClient { * Stores the members of the union of all given sets specified by `keys` into a new set * at `destination`. * - * See https://valkey.io/commands/sunionstore/ for details. - * + * @see {@link https://valkey.io/commands/sunionstore/|valkey.io} for details. * @remarks When in cluster mode, `destination` and all `keys` must map to the same hash slot. + * * @param destination - The key of the destination set. * @param keys - The keys from which to retrieve the set members. * @returns The number of elements in the resulting set. @@ -2575,7 +2600,8 @@ export class BaseClient { } /** Returns if `member` is a member of the set stored at `key`. - * See https://valkey.io/commands/sismember/ for more details. + * + * @see {@link https://valkey.io/commands/sismember/|valkey.io} for more details. * * @param key - The key of the set. * @param member - The member to check for existence in the set. @@ -2603,14 +2629,13 @@ export class BaseClient { /** * Checks whether each member is contained in the members of the set stored at `key`. * - * See https://valkey.io/commands/smismember/ for more details. + * @see {@link https://valkey.io/commands/smismember/|valkey.io} for more details. + * @remarks Since Valkey version 6.2.0. * * @param key - The key of the set to check. * @param members - A list of members to check for existence in the set. * @returns An `array` of `boolean` values, each indicating if the respective member exists in the set. * - * since Valkey version 6.2.0. - * * @example * ```typescript * await client.sadd("set1", ["a", "b", "c"]); @@ -2626,8 +2651,9 @@ export class BaseClient { } /** Removes and returns one random member from the set value store at `key`. - * See https://valkey.io/commands/spop/ for details. - * To pop multiple members, see `spopCount`. + * To pop multiple members, see {@link spopCount}. + * + * @see {@link https://valkey.io/commands/spop/|valkey.io} for details. * * @param key - The key of the set. * @returns the value of the popped member. @@ -2652,7 +2678,8 @@ export class BaseClient { } /** Removes and returns up to `count` random members from the set value store at `key`, depending on the set's length. - * See https://valkey.io/commands/spop/ for details. + * + * @see {@link https://valkey.io/commands/spop/|valkey.io} for details. * * @param key - The key of the set. * @param count - The count of the elements to pop from the set. @@ -2682,7 +2709,7 @@ export class BaseClient { /** * Returns a random element from the set value stored at `key`. * - * See https://valkey.io/commands/srandmember for more details. + * @see {@link https://valkey.io/commands/srandmember/|valkey.io} for more details. * * @param key - The key from which to retrieve the set member. * @returns A random element from the set, or null if `key` does not exist. @@ -2708,7 +2735,7 @@ export class BaseClient { /** * Returns one or more random elements from the set value stored at `key`. * - * See https://valkey.io/commands/srandmember for more details. + * @see {@link https://valkey.io/commands/srandmember/|valkey.io} for more details. * * @param key - The key of the sorted set. * @param count - The number of members to return. @@ -2738,7 +2765,8 @@ export class BaseClient { } /** Returns the number of keys in `keys` that exist in the database. - * See https://valkey.io/commands/exists/ for details. + * + * @see {@link https://valkey.io/commands/exists/|valkey.io} for details. * * @param keys - The keys list to check. * @returns The number of keys that exist. If the same existing key is mentioned in `keys` multiple times, @@ -2758,7 +2786,8 @@ export class BaseClient { /** Removes the specified keys. A key is ignored if it does not exist. * This command, similar to DEL, removes specified keys and ignores non-existent ones. * However, this command does not block the server, while [DEL](https://valkey.io/commands/del) does. - * See https://valkey.io/commands/unlink/ for details. + * + * @see {@link https://valkey.io/commands/unlink/|valkey.io} for details. * * @param keys - The keys we wanted to unlink. * @returns The number of keys that were unlinked. @@ -2778,7 +2807,8 @@ export class BaseClient { * If `key` already has an existing expire set, the time to live is updated to the new value. * If `seconds` is non-positive number, the key will be deleted rather than expired. * The timeout will only be cleared by commands that delete or overwrite the contents of `key`. - * See https://valkey.io/commands/expire/ for details. + * + * @see {@link https://valkey.io/commands/expire/|valkey.io} for details. * * @param key - The key to set timeout on it. * @param seconds - The timeout in seconds. @@ -2812,7 +2842,8 @@ export class BaseClient { * A timestamp in the past will delete the key immediately. After the timeout has expired, the key will automatically be deleted. * If `key` already has an existing expire set, the time to live is updated to the new value. * The timeout will only be cleared by commands that delete or overwrite the contents of `key`. - * See https://valkey.io/commands/expireat/ for details. + * + * @see {@link https://valkey.io/commands/expireat/|valkey.io} for details. * * @param key - The key to set timeout on it. * @param unixSeconds - The timeout in an absolute Unix timestamp. @@ -2841,13 +2872,12 @@ export class BaseClient { * Returns the absolute Unix timestamp (since January 1, 1970) at which the given `key` will expire, in seconds. * To get the expiration with millisecond precision, use {@link pexpiretime}. * - * See https://valkey.io/commands/expiretime/ for details. + * @see {@link https://valkey.io/commands/expiretime/|valkey.io} for details. + * @remarks Since Valkey version 7.0.0. * * @param key - The `key` to determine the expiration value of. * @returns The expiration Unix timestamp in seconds, `-2` if `key` does not exist or `-1` if `key` exists but has no associated expire. * - * since Valkey version 7.0.0. - * * @example * ```typescript * const result1 = await client.expiretime("myKey"); @@ -2870,7 +2900,8 @@ export class BaseClient { * If `key` already has an existing expire set, the time to live is updated to the new value. * If `milliseconds` is non-positive number, the key will be deleted rather than expired. * The timeout will only be cleared by commands that delete or overwrite the contents of `key`. - * See https://valkey.io/commands/pexpire/ for details. + * + * @see {@link https://valkey.io/commands/pexpire/|valkey.io} for details. * * @param key - The key to set timeout on it. * @param milliseconds - The timeout in milliseconds. @@ -2899,7 +2930,8 @@ export class BaseClient { * A timestamp in the past will delete the key immediately. After the timeout has expired, the key will automatically be deleted. * If `key` already has an existing expire set, the time to live is updated to the new value. * The timeout will only be cleared by commands that delete or overwrite the contents of `key`. - * See https://valkey.io/commands/pexpireat/ for details. + * + * @see {@link https://valkey.io/commands/pexpireat/|valkey.io} for details. * * @param key - The key to set timeout on it. * @param unixMilliseconds - The timeout in an absolute Unix timestamp. @@ -2927,13 +2959,12 @@ export class BaseClient { /** * Returns the absolute Unix timestamp (since January 1, 1970) at which the given `key` will expire, in milliseconds. * - * See https://valkey.io/commands/pexpiretime/ for details. + * @see {@link https://valkey.io/commands/pexpiretime/|valkey.io} for details. + * @remarks Since Valkey version 7.0.0. * * @param key - The `key` to determine the expiration value of. * @returns The expiration Unix timestamp in seconds, `-2` if `key` does not exist or `-1` if `key` exists but has no associated expire. * - * since Valkey version 7.0.0. - * * @example * ```typescript * const result1 = client.pexpiretime("myKey"); @@ -2953,7 +2984,8 @@ export class BaseClient { } /** Returns the remaining time to live of `key` that has a timeout. - * See https://valkey.io/commands/ttl/ for details. + * + * @see {@link https://valkey.io/commands/ttl/|valkey.io} for details. * * @param key - The key to return its timeout. * @returns TTL in seconds, -2 if `key` does not exist or -1 if `key` exists but has no associated expire. @@ -2984,10 +3016,11 @@ export class BaseClient { } /** Invokes a Lua script with its keys and arguments. - * This method simplifies the process of invoking scripts on a Redis server by using an object that represents a Lua script. + * This method simplifies the process of invoking scripts on a Valkey server by using an object that represents a Lua script. * The script loading, argument preparation, and execution will all be handled internally. If the script has not already been loaded, - * it will be loaded automatically using the Redis `SCRIPT LOAD` command. After that, it will be invoked using the Redis `EVALSHA` command - * See https://valkey.io/commands/script-load/ and https://valkey.io/commands/evalsha/ for details. + * it will be loaded automatically using the `SCRIPT LOAD` command. After that, it will be invoked using the `EVALSHA` command. + * + * @see {@link https://valkey.io/commands/script-load/|SCRIPT LOAD} and {@link https://valkey.io/commands/evalsha/|EVALSHA} on valkey.io for details. * * @param script - The Lua script to execute. * @param options - The script option that contains keys and arguments for the script. @@ -3035,7 +3068,7 @@ export class BaseClient { /** * Returns stream entries matching a given range of entry IDs. * - * See https://valkey.io/commands/xrange for more details. + * @see {@link https://valkey.io/commands/xrange/|valkey.io} for more details. * * @param key - The key of the stream. * @param start - The starting stream entry ID bound for the range. @@ -3073,7 +3106,8 @@ export class BaseClient { /** Adds members with their scores to the sorted set stored at `key`. * If a member is already a part of the sorted set, its score is updated. - * See https://valkey.io/commands/zadd/ for more details. + * + * @see {@link https://valkey.io/commands/zadd/|valkey.io} for more details. * * @param key - The key of the sorted set. * @param membersScoresMap - A mapping of members to their corresponding scores. @@ -3109,7 +3143,8 @@ export class BaseClient { /** Increments the score of member in the sorted set stored at `key` by `increment`. * If `member` does not exist in the sorted set, it is added with `increment` as its score (as if its previous score was 0.0). * If `key` does not exist, a new sorted set with the specified member as its sole member is created. - * See https://valkey.io/commands/zadd/ for more details. + * + * @see {@link https://valkey.io/commands/zadd/|valkey.io} for more details. * * @param key - The key of the sorted set. * @param member - A member in the sorted set to increment. @@ -3145,7 +3180,8 @@ export class BaseClient { /** Removes the specified members from the sorted set stored at `key`. * Specified members that are not a member of this set are ignored. - * See https://valkey.io/commands/zrem/ for more details. + * + * @see {@link https://valkey.io/commands/zrem/|valkey.io} for more details. * * @param key - The key of the sorted set. * @param members - A list of members to remove from the sorted set. @@ -3171,7 +3207,8 @@ export class BaseClient { } /** Returns the cardinality (number of elements) of the sorted set stored at `key`. - * See https://valkey.io/commands/zcard/ for more details. + * + * @see {@link https://valkey.io/commands/zcard/|valkey.io} for more details. * * @param key - The key of the sorted set. * @returns The number of elements in the sorted set. @@ -3198,16 +3235,15 @@ export class BaseClient { /** * Returns the cardinality of the intersection of the sorted sets specified by `keys`. * - * See https://valkey.io/commands/zintercard/ for more details. - * + * @see {@link https://valkey.io/commands/zintercard/|valkey.io} for more details. * @remarks When in cluster mode, all `keys` must map to the same hash slot. + * @remarks Since Valkey version 7.0.0. + * * @param keys - The keys of the sorted sets to intersect. * @param limit - An optional argument that can be used to specify a maximum number for the * intersection cardinality. If limit is not supplied, or if it is set to `0`, there will be no limit. * @returns The cardinality of the intersection of the given sorted sets. * - * since - Redis version 7.0.0. - * * @example * ```typescript * const cardinality = await client.zintercard(["key1", "key2"], 10); @@ -3222,15 +3258,14 @@ export class BaseClient { * Returns the difference between the first sorted set and all the successive sorted sets. * To get the elements with their scores, see {@link zdiffWithScores}. * - * See https://valkey.io/commands/zdiff/ for more details. - * + * @see {@link https://valkey.io/commands/zdiff/|valkey.io} for more details. * @remarks When in cluster mode, all `keys` must map to the same hash slot. + * @remarks Since Valkey version 6.2.0. + * * @param keys - The keys of the sorted sets. * @returns An `array` of elements representing the difference between the sorted sets. * If the first key does not exist, it is treated as an empty sorted set, and the command returns an empty `array`. * - * since Valkey version 6.2.0. - * * @example * ```typescript * await client.zadd("zset1", {"member1": 1.0, "member2": 2.0, "member3": 3.0}); @@ -3248,15 +3283,14 @@ export class BaseClient { * Returns the difference between the first sorted set and all the successive sorted sets, with the associated * scores. * - * See https://valkey.io/commands/zdiff/ for more details. - * + * @see {@link https://valkey.io/commands/zdiff/|valkey.io} for more details. * @remarks When in cluster mode, all `keys` must map to the same hash slot. + * @remarks Since Valkey version 6.2.0. + * * @param keys - The keys of the sorted sets. * @returns A map of elements and their scores representing the difference between the sorted sets. * If the first key does not exist, it is treated as an empty sorted set, and the command returns an empty `array`. * - * since Valkey version 6.2.0. - * * @example * ```typescript * await client.zadd("zset1", {"member1": 1.0, "member2": 2.0, "member3": 3.0}); @@ -3277,15 +3311,14 @@ export class BaseClient { * the difference as a sorted set to `destination`, overwriting it if it already exists. Non-existent keys are * treated as empty sets. * - * See https://valkey.io/commands/zdiffstore/ for more details. - * + * @see {@link https://valkey.io/commands/zdiffstore/|valkey.io} for more details. * @remarks When in cluster mode, all keys in `keys` and `destination` must map to the same hash slot. + * @remarks Since Valkey version 6.2.0. + * * @param destination - The key for the resulting sorted set. * @param keys - The keys of the sorted sets to compare. * @returns The number of members in the resulting sorted set stored at `destination`. * - * since Valkey version 6.2.0. - * * @example * ```typescript * await client.zadd("zset1", {"member1": 1.0, "member2": 2.0}); @@ -3305,7 +3338,8 @@ export class BaseClient { } /** Returns the score of `member` in the sorted set stored at `key`. - * See https://valkey.io/commands/zscore/ for more details. + * + * @see {@link https://valkey.io/commands/zscore/|valkey.io} for more details. * * @param key - The key of the sorted set. * @param member - The member whose score is to be retrieved. @@ -3341,15 +3375,14 @@ export class BaseClient { /** * Returns the scores associated with the specified `members` in the sorted set stored at `key`. * - * See https://valkey.io/commands/zmscore/ for more details. + * @see {@link https://valkey.io/commands/zmscore/|valkey.io} for more details. + * @remarks Since Valkey version 6.2.0. * * @param key - The key of the sorted set. * @param members - A list of members in the sorted set. * @returns An `array` of scores corresponding to `members`. * If a member does not exist in the sorted set, the corresponding value in the list will be `null`. * - * since Valkey version 6.2.0. - * * @example * ```typescript * const result = await client.zmscore("zset1", ["member1", "non_existent_member", "member2"]); @@ -3364,7 +3397,8 @@ export class BaseClient { } /** Returns the number of members in the sorted set stored at `key` with scores between `minScore` and `maxScore`. - * See https://valkey.io/commands/zcount/ for more details. + * + * @see {@link https://valkey.io/commands/zcount/|valkey.io} for more details. * * @param key - The key of the sorted set. * @param minScore - The minimum score to count from. Can be positive/negative infinity, or specific score and inclusivity. @@ -3398,8 +3432,9 @@ export class BaseClient { /** Returns the specified range of elements in the sorted set stored at `key`. * ZRANGE can perform different types of range queries: by index (rank), by the score, or by lexicographical order. * - * See https://valkey.io/commands/zrange/ for more details. - * To get the elements with their scores, see `zrangeWithScores`. + * To get the elements with their scores, see {@link zrangeWithScores}. + * + * @see {@link https://valkey.io/commands/zrange/|valkey.io} for more details. * * @param key - The key of the sorted set. * @param rangeQuery - The range query object representing the type of range query to perform. @@ -3437,7 +3472,8 @@ export class BaseClient { /** Returns the specified range of elements with their scores in the sorted set stored at `key`. * Similar to ZRANGE but with a WITHSCORE flag. - * See https://valkey.io/commands/zrange/ for more details. + * + * @see {@link https://valkey.io/commands/zrange/|valkey.io} for more details. * * @param key - The key of the sorted set. * @param rangeQuery - The range query object representing the type of range query to perform. @@ -3484,9 +3520,10 @@ export class BaseClient { * sorted set at `destination`. If `destination` doesn't exist, a new sorted * set is created; if it exists, it's overwritten. * - * See https://valkey.io/commands/zrangestore/ for more details. - * + * @see {@link https://valkey.io/commands/zrangestore/|valkey.io} for more details. * @remarks When in cluster mode, `destination` and `source` must map to the same hash slot. + * @remarks Since Valkey version 6.2.0. + * * @param destination - The key for the destination sorted set. * @param source - The key of the source sorted set. * @param rangeQuery - The range query object representing the type of range query to perform. @@ -3496,8 +3533,6 @@ export class BaseClient { * @param reverse - If `true`, reverses the sorted set, with index `0` as the element with the highest score. * @returns The number of elements in the resulting sorted set. * - * since - Redis version 6.2.0. - * * @example * ```typescript * // Example usage of zrangeStore to retrieve and store all members of a sorted set in ascending order. @@ -3531,9 +3566,8 @@ export class BaseClient { * If `destination` already exists, it is overwritten. Otherwise, a new sorted set will be created. * To get the result directly, see `zinter_withscores`. * - * When in cluster mode, `destination` and all keys in `keys` must map to the same hash slot. - * - * See https://valkey.io/commands/zinterstore/ for more details. + * @see {@link https://valkey.io/commands/zinterstore/|valkey.io} for more details. + * @remarks When in cluster mode, `destination` and all keys in `keys` must map to the same hash slot. * * @param destination - The key of the destination sorted set. * @param keys - The keys of the sorted sets with possible formats: @@ -3566,7 +3600,7 @@ export class BaseClient { /** * Returns a random member from the sorted set stored at `key`. * - * See https://valkey.io/commands/zrandmember/ for more details. + * @see {@link https://valkey.io/commands/zrandmember/|valkey.io} for more details. * * @param keys - The key of the sorted set. * @returns A string representing a random member from the sorted set. @@ -3591,7 +3625,7 @@ export class BaseClient { /** * Returns random members from the sorted set stored at `key`. * - * See https://valkey.io/commands/zrandmember/ for more details. + * @see {@link https://valkey.io/commands/zrandmember/|valkey.io} for more details. * * @param keys - The key of the sorted set. * @param count - The number of members to return. @@ -3622,7 +3656,7 @@ export class BaseClient { /** * Returns random members with scores from the sorted set stored at `key`. * - * See https://valkey.io/commands/zrandmember/ for more details. + * @see {@link https://valkey.io/commands/zrandmember/|valkey.io} for more details. * * @param keys - The key of the sorted set. * @param count - The number of members to return. @@ -3652,7 +3686,8 @@ export class BaseClient { } /** Returns the length of the string value stored at `key`. - * See https://valkey.io/commands/strlen/ for more details. + * + * @see {@link https://valkey.io/commands/strlen/|valkey.io} for more details. * * @param key - The key to check its length. * @returns - The length of the string value stored at key @@ -3678,7 +3713,8 @@ export class BaseClient { } /** Returns the string representation of the type of the value stored at `key`. - * See https://valkey.io/commands/type/ for more details. + * + * @see {@link https://valkey.io/commands/type/|valkey.io} for more details. * * @param key - The `key` to check its data type. * @returns If the `key` exists, the type of the stored value is returned. Otherwise, a "none" string is returned. @@ -3706,7 +3742,8 @@ export class BaseClient { /** Removes and returns the members with the lowest scores from the sorted set stored at `key`. * If `count` is provided, up to `count` members with the lowest scores are removed and returned. * Otherwise, only one member with the lowest score is removed and returned. - * See https://valkey.io/commands/zpopmin for more details. + * + * @see {@link https://valkey.io/commands/zpopmin/|valkey.io} for more details. * * @param key - The key of the sorted set. * @param count - Specifies the quantity of members to pop. If not specified, pops one member. @@ -3741,9 +3778,9 @@ export class BaseClient { * are provided. * `BZPOPMIN` is the blocking variant of {@link zpopmin}. * - * See https://valkey.io/commands/bzpopmin/ for more details. - * + * @see {@link https://valkey.io/commands/bzpopmin/|valkey.io} for more details. * @remarks When in cluster mode, `keys` must map to the same hash slot. + * * @param keys - The keys of the sorted sets. * @param timeout - The number of seconds to wait for a blocking operation to complete. A value of * `0` will block indefinitely. Since 6.0.0: timeout is interpreted as a double instead of an integer. @@ -3766,7 +3803,8 @@ export class BaseClient { /** Removes and returns the members with the highest scores from the sorted set stored at `key`. * If `count` is provided, up to `count` members with the highest scores are removed and returned. * Otherwise, only one member with the highest score is removed and returned. - * See https://valkey.io/commands/zpopmax for more details. + * + * @see {@link https://valkey.io/commands/zpopmax/|valkey.io} for more details. * * @param key - The key of the sorted set. * @param count - Specifies the quantity of members to pop. If not specified, pops one member. @@ -3801,9 +3839,9 @@ export class BaseClient { * are provided. * `BZPOPMAX` is the blocking variant of {@link zpopmax}. * - * See https://valkey.io/commands/zpopmax/ for more details. - * + * @see {@link https://valkey.io/commands/zpopmax/|valkey.io} for more details. * @remarks When in cluster mode, `keys` must map to the same hash slot. + * * @param keys - The keys of the sorted sets. * @param timeout - The number of seconds to wait for a blocking operation to complete. A value of * `0` will block indefinitely. Since 6.0.0: timeout is interpreted as a double instead of an integer. @@ -3824,7 +3862,8 @@ export class BaseClient { } /** Returns the remaining time to live of `key` that has a timeout, in milliseconds. - * See https://valkey.io/commands/pttl for more details. + * + * @see {@link https://valkey.io/commands/pttl/|valkey.io} for more details. * * @param key - The key to return its timeout. * @returns TTL in milliseconds. -2 if `key` does not exist, -1 if `key` exists but has no associated expire. @@ -3857,7 +3896,8 @@ export class BaseClient { /** Removes all elements in the sorted set stored at `key` with rank between `start` and `end`. * Both `start` and `end` are zero-based indexes with 0 being the element with the lowest score. * These indexes can be negative numbers, where they indicate offsets starting at the element with the highest score. - * See https://valkey.io/commands/zremrangebyrank/ for more details. + * + * @see {@link https://valkey.io/commands/zremrangebyrank/|valkey.io} for more details. * * @param key - The key of the sorted set. * @param start - The starting point of the range. @@ -3885,7 +3925,7 @@ export class BaseClient { /** * Removes all elements in the sorted set stored at `key` with lexicographical order between `minLex` and `maxLex`. * - * See https://valkey.io/commands/zremrangebylex/ for more details. + * @see {@link https://valkey.io/commands/zremrangebylex/|valkey.io} for more details. * * @param key - The key of the sorted set. * @param minLex - The minimum lex to count from. Can be positive/negative infinity, or a specific lex and inclusivity. @@ -3919,7 +3959,8 @@ export class BaseClient { } /** Removes all elements in the sorted set stored at `key` with a score between `minScore` and `maxScore`. - * See https://valkey.io/commands/zremrangebyscore/ for more details. + * + * @see {@link https://valkey.io/commands/zremrangebyscore/|valkey.io} for more details. * * @param key - The key of the sorted set. * @param minScore - The minimum score to remove from. Can be positive/negative infinity, or specific score and inclusivity. @@ -3955,7 +3996,7 @@ export class BaseClient { /** * Returns the number of members in the sorted set stored at 'key' with scores between 'minLex' and 'maxLex'. * - * See https://valkey.io/commands/zlexcount/ for more details. + * @see {@link https://valkey.io/commands/zlexcount/|valkey.io} for more details. * * @param key - The key of the sorted set. * @param minLex - The minimum lex to count from. Can be positive/negative infinity, or a specific lex and inclusivity. @@ -3985,8 +4026,9 @@ export class BaseClient { } /** Returns the rank of `member` in the sorted set stored at `key`, with scores ordered from low to high. - * See https://valkey.io/commands/zrank for more details. - * To get the rank of `member` with its score, see `zrankWithScore`. + * To get the rank of `member` with its score, see {@link zrankWithScore}. + * + * @see {@link https://valkey.io/commands/zrank/|valkey.io} for more details. * * @param key - The key of the sorted set. * @param member - The member whose rank is to be retrieved. @@ -4012,15 +4054,15 @@ export class BaseClient { } /** Returns the rank of `member` in the sorted set stored at `key` with its score, where scores are ordered from the lowest to highest. - * See https://valkey.io/commands/zrank for more details. + * + * @see {@link https://valkey.io/commands/zrank/|valkey.io} for more details. + * @remarks Since Valkey version 7.2.0. * * @param key - The key of the sorted set. * @param member - The member whose rank is to be retrieved. * @returns A list containing the rank and score of `member` in the sorted set. * If `key` doesn't exist, or if `member` is not present in the set, null will be returned. * - * since - Redis version 7.2.0. - * * @example * ```typescript * // Example usage of zrank_withscore method to retrieve the rank and score of a member in a sorted set @@ -4047,7 +4089,7 @@ export class BaseClient { * scores are ordered from the highest to lowest, starting from 0. * To get the rank of `member` with its score, see {@link zrevrankWithScore}. * - * See https://valkey.io/commands/zrevrank/ for more details. + * @see {@link https://valkey.io/commands/zrevrank/|valkey.io} for more details. * * @param key - The key of the sorted set. * @param member - The member whose rank is to be retrieved. @@ -4068,7 +4110,8 @@ export class BaseClient { * Returns the rank of `member` in the sorted set stored at `key` with its * score, where scores are ordered from the highest to lowest, starting from 0. * - * See https://valkey.io/commands/zrevrank/ for more details. + * @see {@link https://valkey.io/commands/zrevrank/|valkey.io} for more details. + * @remarks Since Valkey version 7.2.0. * * @param key - The key of the sorted set. * @param member - The member whose rank is to be retrieved. @@ -4076,8 +4119,6 @@ export class BaseClient { * are ordered from high to low based on scores. * If `key` doesn't exist, or if `member` is not present in the set, `null` will be returned. * - * since - Valkey version 7.2.0. - * * @example * ```typescript * const result = await client.zrevankWithScore("my_sorted_set", "member2"); @@ -4093,7 +4134,8 @@ export class BaseClient { /** * Adds an entry to the specified stream stored at `key`. If the `key` doesn't exist, the stream is created. - * See https://valkey.io/commands/xadd/ for more details. + * + * @see {@link https://valkey.io/commands/xadd/|valkey.io} for more details. * * @param key - The key of the stream. * @param values - field-value pairs to be added to the entry. @@ -4111,7 +4153,7 @@ export class BaseClient { /** * Removes the specified entries by id from a stream, and returns the number of entries deleted. * - * See https://valkey.io/commands/xdel for more details. + * @see {@link https://valkey.io/commands/xdel/|valkey.io} for more details. * * @param key - The key of the stream. * @param ids - An array of entry ids. @@ -4130,7 +4172,8 @@ export class BaseClient { /** * Trims the stream stored at `key` by evicting older entries. - * See https://valkey.io/commands/xtrim/ for more details. + * + * @see {@link https://valkey.io/commands/xtrim/|valkey.io} for more details. * * @param key - the key of the stream * @param options - options detailing how to trim the stream. @@ -4145,7 +4188,8 @@ export class BaseClient { /** * Reads entries from the given streams. - * See https://valkey.io/commands/xread/ for more details. + * + * @see {@link https://valkey.io/commands/xread/|valkey.io} for more details. * * @param keys_and_ids - pairs of keys and entry ids to read from. A pair is composed of a stream's key and the id of the entry after which the stream will be read. * @param options - options detailing how to read the stream. @@ -4176,7 +4220,7 @@ export class BaseClient { /** * Returns the number of entries in the stream stored at `key`. * - * See https://valkey.io/commands/xlen/ for more details. + * @see {@link https://valkey.io/commands/xlen/|valkey.io} for more details. * * @param key - The key of the stream. * @returns The number of entries in the stream. If `key` does not exist, returns `0`. @@ -4194,7 +4238,7 @@ export class BaseClient { /** * Returns stream message summary information for pending messages matching a given range of IDs. * - * See https://valkey.io/commands/xpending/ for more details. + * @see {@link https://valkey.io/commands/xpending/|valkey.io} for more details. * * @param key - The key of the stream. * @param group - The consumer group name. @@ -4223,7 +4267,7 @@ export class BaseClient { /** * Returns an extended form of stream message information for pending messages matching a given range of IDs. * - * See https://valkey.io/commands/xpending/ for more details. + * @see {@link https://valkey.io/commands/xpending/|valkey.io} for more details. * * @param key - The key of the stream. * @param group - The consumer group name. @@ -4266,7 +4310,7 @@ export class BaseClient { * Returns the list of all consumers and their attributes for the given consumer group of the * stream stored at `key`. * - * See https://valkey.io/commands/xinfo-consumers/ for more details. + * @see {@link https://valkey.io/commands/xinfo-consumers/|valkey.io} for more details. * * @param key - The key of the stream. * @param group - The consumer group name. @@ -4298,7 +4342,7 @@ export class BaseClient { /** * Changes the ownership of a pending message. * - * See https://valkey.io/commands/xclaim/ for more details. + * @see {@link https://valkey.io/commands/xclaim/|valkey.io} for more details. * * @param key - The key of the stream. * @param group - The consumer group name. @@ -4334,9 +4378,8 @@ export class BaseClient { /** * Transfers ownership of pending stream entries that match the specified criteria. * - * See https://valkey.io/commands/xautoclaim/ for more details. - * - * since Valkey version 6.2.0. + * @see {@link https://valkey.io/commands/xautoclaim/|valkey.io} for more details. + * @remarks Since Valkey version 6.2.0. * * @param key - The key of the stream. * @param group - The consumer group name. @@ -4390,9 +4433,8 @@ export class BaseClient { /** * Transfers ownership of pending stream entries that match the specified criteria. * - * See https://valkey.io/commands/xautoclaim/ for more details. - * - * since Valkey version 6.2.0. + * @see {@link https://valkey.io/commands/xautoclaim/|valkey.io} for more details. + * @remarks Since Valkey version 6.2.0. * * @param key - The key of the stream. * @param group - The consumer group name. @@ -4453,7 +4495,7 @@ export class BaseClient { * Changes the ownership of a pending message. This function returns an `array` with * only the message/entry IDs, and is equivalent to using `JUSTID` in the Valkey API. * - * See https://valkey.io/commands/xclaim/ for more details. + * @see {@link https://valkey.io/commands/xclaim/|valkey.io} for more details. * * @param key - The key of the stream. * @param group - The consumer group name. @@ -4486,7 +4528,7 @@ export class BaseClient { /** * Creates a new consumer group uniquely identified by `groupname` for the stream stored at `key`. * - * See https://valkey.io/commands/xgroup-create/ for more details. + * @see {@link https://valkey.io/commands/xgroup-create/|valkey.io} for more details. * * @param key - The key of the stream. * @param groupName - The newly created consumer group name. @@ -4514,7 +4556,7 @@ export class BaseClient { /** * Destroys the consumer group `groupname` for the stream stored at `key`. * - * See https://valkey.io/commands/xgroup-destroy/ for more details. + * @see {@link https://valkey.io/commands/xgroup-destroy/|valkey.io} for more details. * * @param key - The key of the stream. * @param groupname - The newly created consumer group name. @@ -4536,12 +4578,15 @@ export class BaseClient { /** * Returns information about the stream stored at `key`. * + * @see {@link https://valkey.io/commands/xinfo-stream/|valkey.io} for more details. + * * @param key - The key of the stream. * @param fullOptions - If `true`, returns verbose information with a limit of the first 10 PEL entries. * If `number` is specified, returns verbose information limiting the returned PEL entries. * If `0` is specified, returns verbose information with no limit. * @returns A {@link ReturnTypeXinfoStream} of detailed stream information for the given `key`. See * the example for a sample response. + * * @example * ```typescript * const infoResult = await client.xinfoStream("my_stream"); @@ -4606,7 +4651,7 @@ export class BaseClient { /** * Creates a consumer named `consumerName` in the consumer group `groupName` for the stream stored at `key`. * - * See https://valkey.io/commands/xgroup-createconsumer for more details. + * @see {@link https://valkey.io/commands/xgroup-createconsumer/|valkey.io} for more details. * * @param key - The key of the stream. * @param groupName - The consumer group name. @@ -4632,7 +4677,7 @@ export class BaseClient { /** * Deletes a consumer named `consumerName` in the consumer group `groupName` for the stream stored at `key`. * - * See https://valkey.io/commands/xgroup-delconsumer for more details. + * @see {@link https://valkey.io/commands/xgroup-delconsumer/|valkey.io} for more details. * * @param key - The key of the stream. * @param groupName - The consumer group name. @@ -4667,7 +4712,8 @@ export class BaseClient { * The index is zero-based, so 0 means the first element, 1 the second element and so on. * Negative indices can be used to designate elements starting at the tail of the list. * Here, -1 means the last element, -2 means the penultimate and so forth. - * See https://valkey.io/commands/lindex/ for more details. + * + * @see {@link https://valkey.io/commands/lindex/|valkey.io} for more details. * * @param key - The `key` of the list. * @param index - The `index` of the element in the list to retrieve. @@ -4695,7 +4741,7 @@ export class BaseClient { /** * Inserts `element` in the list at `key` either before or after the `pivot`. * - * See https://valkey.io/commands/linsert/ for more details. + * @see {@link https://valkey.io/commands/linsert/|valkey.io} for more details. * * @param key - The key of the list. * @param position - The relative position to insert into - either `InsertPosition.Before` or @@ -4725,7 +4771,8 @@ export class BaseClient { /** Remove the existing timeout on `key`, turning the key from volatile (a key with an expire set) to * persistent (a key that will never expire as no timeout is associated). - * See https://valkey.io/commands/persist/ for more details. + * + * @see {@link https://valkey.io/commands/persist/|valkey.io} for more details. * * @param key - The key to remove the existing timeout on. * @returns `false` if `key` does not exist or does not have an associated timeout, `true` if the timeout has been removed. @@ -4744,9 +4791,10 @@ export class BaseClient { /** * Renames `key` to `newkey`. * If `newkey` already exists it is overwritten. - * See https://valkey.io/commands/rename/ for more details. * + * @see {@link https://valkey.io/commands/rename/|valkey.io} for more details. * @remarks When in cluster mode, `key` and `newKey` must map to the same hash slot. + * * @param key - The key to rename. * @param newKey - The new name of the key. * @returns - If the `key` was successfully renamed, return "OK". If `key` does not exist, an error is thrown. @@ -4765,9 +4813,10 @@ export class BaseClient { /** * Renames `key` to `newkey` if `newkey` does not yet exist. - * See https://valkey.io/commands/renamenx/ for more details. * + * @see {@link https://valkey.io/commands/renamenx/|valkey.io} for more details. * @remarks When in cluster mode, `key` and `newKey` must map to the same hash slot. + * * @param key - The key to rename. * @param newKey - The new name of the key. * @returns - If the `key` was successfully renamed, returns `true`. Otherwise, returns `false`. @@ -4789,11 +4838,11 @@ export class BaseClient { * Pop an element from the tail of the first list that is non-empty, * with the given `keys` being checked in the order that they are given. * Blocks the connection when there are no elements to pop from any of the given lists. - * See https://valkey.io/commands/brpop/ for more details. * - * @remarks - * 1. When in cluster mode, all `keys` must map to the same hash slot. - * 2. `BRPOP` is a blocking command, see [Blocking Commands](https://github.com/valkey-io/valkey-glide/wiki/General-Concepts#blocking-commands) for more details and best practices. + * @see {@link https://valkey.io/commands/brpop/|valkey.io} for more details. + * @remarks When in cluster mode, all `keys` must map to the same hash slot. + * @remarks `BRPOP` is a blocking command, see [Blocking Commands](https://github.com/valkey-io/valkey-glide/wiki/General-Concepts#blocking-commands) for more details and best practices. + * * @param keys - The `keys` of the lists to pop from. * @param timeout - The `timeout` in seconds. * @returns - An `array` containing the `key` from which the element was popped and the value of the popped element, @@ -4817,11 +4866,11 @@ export class BaseClient { * Pop an element from the head of the first list that is non-empty, * with the given `keys` being checked in the order that they are given. * Blocks the connection when there are no elements to pop from any of the given lists. - * See https://valkey.io/commands/blpop/ for more details. * - * @remarks - * 1. When in cluster mode, all `keys` must map to the same hash slot. - * 2. `BLPOP` is a blocking command, see [Blocking Commands](https://github.com/valkey-io/valkey-glide/wiki/General-Concepts#blocking-commands) for more details and best practices. + * @see {@link https://valkey.io/commands/blpop/|valkey.io} for more details. + * @remarks When in cluster mode, all `keys` must map to the same hash slot. + * @remarks `BLPOP` is a blocking command, see [Blocking Commands](https://github.com/valkey-io/valkey-glide/wiki/General-Concepts#blocking-commands) for more details and best practices. + * * @param keys - The `keys` of the lists to pop from. * @param timeout - The `timeout` in seconds. * @returns - An `array` containing the `key` from which the element was popped and the value of the popped element, @@ -4844,7 +4893,7 @@ export class BaseClient { * Creates a new structure if the `key` does not exist. * When no elements are provided, and `key` exists and is a HyperLogLog, then no operation is performed. * - * See https://valkey.io/commands/pfadd/ for more details. + * @see {@link https://valkey.io/commands/pfadd/|valkey.io} for more details. * * @param key - The key of the HyperLogLog data structure to add elements into. * @param elements - An array of members to add to the HyperLogLog stored at `key`. @@ -4865,9 +4914,9 @@ export class BaseClient { /** Estimates the cardinality of the data stored in a HyperLogLog structure for a single key or * calculates the combined cardinality of multiple keys by merging their HyperLogLogs temporarily. * - * See https://valkey.io/commands/pfcount/ for more details. - * + * @see {@link https://valkey.io/commands/pfcount/|valkey.io} for more details. * @remarks When in cluster mode, all `keys` must map to the same hash slot. + * * @param keys - The keys of the HyperLogLog data structures to be analyzed. * @returns - The approximated cardinality of given HyperLogLog data structures. * The cardinality of a key that does not exist is `0`. @@ -4885,9 +4934,9 @@ export class BaseClient { * Merges multiple HyperLogLog values into a unique value. If the destination variable exists, it is * treated as one of the source HyperLogLog data sets, otherwise a new HyperLogLog is created. * - * See https://valkey.io/commands/pfmerge/ for more details. - * + * @see {@link https://valkey.io/commands/pfmerge/|valkey.io} for more details. * @remarks When in Cluster mode, all keys in `sourceKeys` and `destination` must map to the same hash slot. + * * @param destination - The key of the destination HyperLogLog where the merged data sets will be stored. * @param sourceKeys - The keys of the HyperLogLog structures to be merged. * @returns A simple "OK" response. @@ -4909,9 +4958,9 @@ export class BaseClient { return this.createWritePromise(createPfMerge(destination, sourceKeys)); } - /** Returns the internal encoding for the Redis object stored at `key`. + /** Returns the internal encoding for the Valkey object stored at `key`. * - * See https://valkey.io/commands/object-encoding for more details. + * @see {@link https://valkey.io/commands/object-encoding/|valkey.io} for more details. * * @param key - The `key` of the object to get the internal encoding of. * @returns - If `key` exists, returns the internal encoding of the object stored at `key` as a string. @@ -4926,9 +4975,9 @@ export class BaseClient { return this.createWritePromise(createObjectEncoding(key)); } - /** Returns the logarithmic access frequency counter of a Redis object stored at `key`. + /** Returns the logarithmic access frequency counter of a Valkey object stored at `key`. * - * See https://valkey.io/commands/object-freq for more details. + * @see {@link https://valkey.io/commands/object-freq/|valkey.io} for more details. * * @param key - The `key` of the object to get the logarithmic access frequency counter of. * @returns - If `key` exists, returns the logarithmic access frequency counter of the object @@ -4946,7 +4995,7 @@ export class BaseClient { /** * Returns the time in seconds since the last access to the value stored at `key`. * - * See https://valkey.io/commands/object-idletime/ for more details. + * @see {@link https://valkey.io/commands/object-idletime/|valkey.io} for more details. * * @param key - The key of the object to get the idle time of. * @returns If `key` exists, returns the idle time in seconds. Otherwise, returns `null`. @@ -4964,7 +5013,7 @@ export class BaseClient { /** * Returns the reference count of the object stored at `key`. * - * See https://valkey.io/commands/object-refcount/ for more details. + * @see {@link https://valkey.io/commands/object-refcount/|valkey.io} for more details. * * @param key - The `key` of the object to get the reference count of. * @returns If `key` exists, returns the reference count of the object stored at `key` as a `number`. @@ -4983,11 +5032,10 @@ export class BaseClient { /** * Invokes a previously loaded function. * - * See https://valkey.io/commands/fcall/ for more details. - * - * since Valkey version 7.0.0. - * + * @see {@link https://valkey.io/commands/fcall/|valkey.io} for more details. * @remarks When in cluster mode, all `keys` must map to the same hash slot. + * @remarks Since Valkey version 7.0.0. + * * @param func - The function name. * @param keys - A list of `keys` accessed by the function. To ensure the correct execution of functions, * all names of keys that a function accesses must be explicitly provided as `keys`. @@ -5011,11 +5059,10 @@ export class BaseClient { /** * Invokes a previously loaded read-only function. * - * See https://valkey.io/commands/fcall/ for more details. - * - * since Valkey version 7.0.0. - * + * @see {@link https://valkey.io/commands/fcall/|valkey.io} for more details. * @remarks When in cluster mode, all `keys` must map to the same hash slot. + * @remarks Since Valkey version 7.0.0. + * * @param func - The function name. * @param keys - A list of `keys` accessed by the function. To ensure the correct execution of functions, * all names of keys that a function accesses must be explicitly provided as `keys`. @@ -5042,7 +5089,8 @@ export class BaseClient { * match is found, `null` is returned. If the `count` option is specified, then the function returns * an `array` of indices of matching elements within the list. * - * See https://valkey.io/commands/lpos/ for more details. + * @see {@link https://valkey.io/commands/lpos/|valkey.io} for more details. + * @remarks Since Valkey version 6.0.6. * * @param key - The name of the list. * @param element - The value to search for within the list. @@ -5050,8 +5098,6 @@ export class BaseClient { * @returns The index of `element`, or `null` if `element` is not in the list. If the `count` option * is specified, then the function returns an `array` of indices of matching elements within the list. * - * since - Valkey version 6.0.6. - * * @example * ```typescript * await client.rpush("myList", ["a", "b", "c", "d", "e", "e"]); @@ -5071,7 +5117,7 @@ export class BaseClient { * Counts the number of set bits (population counting) in the string stored at `key`. The `options` argument can * optionally be provided to count the number of bits in a specific string interval. * - * See https://valkey.io/commands/bitcount for more details. + * @see {@link https://valkey.io/commands/bitcount/|valkey.io} for more details. * * @param key - The key for the string to count the set bits of. * @param options - The offset options. @@ -5098,7 +5144,7 @@ export class BaseClient { * Adds geospatial members with their positions to the specified sorted set stored at `key`. * If a member is already a part of the sorted set, its position is updated. * - * See https://valkey.io/commands/geoadd/ for more details. + * @see {@link https://valkey.io/commands/geoadd/|valkey.io} for more details. * * @param key - The key of the sorted set. * @param membersToGeospatialData - A mapping of member names to their corresponding positions - see @@ -5132,9 +5178,8 @@ export class BaseClient { * Returns the members of a sorted set populated with geospatial information using {@link geoadd}, * which are within the borders of the area specified by a given shape. * - * See https://valkey.io/commands/geosearch/ for more details. - * - * since - Valkey 6.2.0 and above. + * @see {@link https://valkey.io/commands/geosearch/|valkey.io} for more details. + * @remarks Since Valkey version 6.2.0. * * @param key - The key of the sorted set. * @param searchFrom - The query's center point options, could be one of: @@ -5214,11 +5259,9 @@ export class BaseClient { * * To get the result directly, see {@link geosearch}. * - * See https://valkey.io/commands/geosearchstore/ for more details. - * - * since - Valkey 6.2.0 and above. - * + * @see {@link https://valkey.io/commands/geosearchstore/|valkey.io} for more details. * @remarks When in cluster mode, `destination` and `source` must map to the same hash slot. + * @remarks Since Valkey version 6.2.0. * * @param destination - The key of the destination sorted set. * @param source - The key of the sorted set. @@ -5289,7 +5332,7 @@ export class BaseClient { * Returns the positions (longitude, latitude) of all the specified `members` of the * geospatial index represented by the sorted set at `key`. * - * See https://valkey.io/commands/geopos for more details. + * @see {@link https://valkey.io/commands/geopos/|valkey.io} for more details. * * @param key - The key of the sorted set. * @param members - The members for which to get the positions. @@ -5318,9 +5361,10 @@ export class BaseClient { * Pops a member-score pair from the first non-empty sorted set, with the given `keys` * being checked in the order they are provided. * - * See https://valkey.io/commands/zmpop/ for more details. - * + * @see {@link https://valkey.io/commands/zmpop/|valkey.io} for more details. * @remarks When in cluster mode, all `keys` must map to the same hash slot. + * @remarks Since Valkey version 7.0.0. + * * @param keys - The keys of the sorted sets. * @param modifier - The element pop criteria - either {@link ScoreFilter.MIN} or * {@link ScoreFilter.MAX} to pop the member with the lowest/highest score accordingly. @@ -5329,8 +5373,6 @@ export class BaseClient { * was popped, and a member-score `Record` of the popped element. * If no member could be popped, returns `null`. * - * since Valkey version 7.0.0. - * * @example * ```typescript * await client.zadd("zSet1", { one: 1.0, two: 2.0, three: 3.0 }); @@ -5352,12 +5394,11 @@ export class BaseClient { * checked in the order they are provided. Blocks the connection when there are no members * to pop from any of the given sorted sets. `BZMPOP` is the blocking variant of {@link zmpop}. * - * See https://valkey.io/commands/bzmpop/ for more details. + * @see {@link https://valkey.io/commands/bzmpop/|valkey.io} for more details. + * @remarks When in cluster mode, all `keys` must map to the same hash slot. + * @remarks `BZMPOP` is a client blocking command, see {@link https://github.com/valkey-io/valkey-glide/wiki/General-Concepts#blocking-commands | Valkey Glide Wiki} for more details and best practices. + * @remarks Since Valkey version 7.0.0. * - * @remarks - * 1. When in cluster mode, all `keys` must map to the same hash slot. - * 2. `BZMPOP` is a client blocking command, see {@link https://github.com/valkey-io/valkey-glide/wiki/General-Concepts#blocking-commands | the wiki} - * for more details and best practices. * @param keys - The keys of the sorted sets. * @param modifier - The element pop criteria - either {@link ScoreFilter.MIN} or * {@link ScoreFilter.MAX} to pop the member with the lowest/highest score accordingly. @@ -5368,8 +5409,6 @@ export class BaseClient { * was popped, and a member-score `Record` of the popped element. * If no member could be popped, returns `null`. * - * since Valkey version 7.0.0. - * * @example * ```typescript * await client.zadd("zSet1", { one: 1.0, two: 2.0, three: 3.0 }); @@ -5394,7 +5433,7 @@ export class BaseClient { * If `member` does not exist in the sorted set, it is added with `increment` as its score. * If `key` does not exist, a new sorted set is created with the specified member as its sole member. * - * See https://valkey.io/commands/zincrby/ for details. + * @see {@link https://valkey.io/commands/zincrby/|valkey.io} for details. * * @param key - The key of the sorted set. * @param increment - The score increment. @@ -5425,7 +5464,7 @@ export class BaseClient { /** * Iterates incrementally over a sorted set. * - * See https://valkey.io/commands/zscan for more details. + * @see {@link https://valkey.io/commands/zscan/|valkey.io} for more details. * * @param key - The key of the sorted set. * @param cursor - The cursor that points to the next iteration of results. A value of `"0"` indicates the start of @@ -5472,7 +5511,7 @@ export class BaseClient { /** * Returns the distance between `member1` and `member2` saved in the geospatial index stored at `key`. * - * See https://valkey.io/commands/geodist/ for more details. + * @see {@link https://valkey.io/commands/geodist/|valkey.io} for more details. * * @param key - The key of the sorted set. * @param member1 - The name of the first member. @@ -5501,7 +5540,7 @@ export class BaseClient { /** * Returns the `GeoHash` strings representing the positions of all the specified `members` in the sorted set stored at `key`. * - * See https://valkey.io/commands/geohash/ for more details. + * @see {@link https://valkey.io/commands/geohash/|valkey.io} for more details. * * @param key - The key of the sorted set. * @param members - The array of members whose `GeoHash` strings are to be retrieved. @@ -5528,11 +5567,9 @@ export class BaseClient { /** * Returns all the longest common subsequences combined between strings stored at `key1` and `key2`. * - * since Valkey version 7.0.0. - * + * @see {@link https://valkey.io/commands/lcs/|valkey.io} for more details. * @remarks When in cluster mode, `key1` and `key2` must map to the same hash slot. - * - * See https://valkey.io/commands/lcs/ for more details. + * @remarks Since Valkey version 7.0.0. * * @param key1 - The key that stores the first string. * @param key2 - The key that stores the second string. @@ -5553,11 +5590,9 @@ export class BaseClient { /** * Returns the total length of all the longest common subsequences between strings stored at `key1` and `key2`. * - * since Valkey version 7.0.0. - * + * @see {@link https://valkey.io/commands/lcs/|valkey.io} for more details. * @remarks When in cluster mode, `key1` and `key2` must map to the same hash slot. - * - * See https://valkey.io/commands/lcs/ for more details. + * @remarks Since Valkey version 7.0.0. * * @param key1 - The key that stores the first string. * @param key2 - The key that stores the second string. @@ -5578,11 +5613,9 @@ export class BaseClient { * Returns the indices and lengths of the longest common subsequences between strings stored at * `key1` and `key2`. * - * since Valkey version 7.0.0. - * + * @see {@link https://valkey.io/commands/lcs/|valkey.io} for more details. * @remarks When in cluster mode, `key1` and `key2` must map to the same hash slot. - * - * See https://valkey.io/commands/lcs/ for more details. + * @remarks Since Valkey version 7.0.0. * * @param key1 - The key that stores the first string. * @param key2 - The key that stores the second string. @@ -5633,9 +5666,9 @@ export class BaseClient { /** * Updates the last access time of the specified keys. * - * See https://valkey.io/commands/touch/ for more details. - * + * @see {@link https://valkey.io/commands/touch/|valkey.io} for more details. * @remarks When in cluster mode, the command may route to multiple nodes when `keys` map to different hash slots. + * * @param keys - The keys to update the last access time of. * @returns The number of keys that were updated. A key is ignored if it doesn't exist. * @@ -5656,9 +5689,9 @@ export class BaseClient { * will only execute commands if the watched keys are not modified before execution of the * transaction. Executing a transaction will automatically flush all previously watched keys. * - * See https://valkey.io/commands/watch/ and https://valkey.io/topics/transactions/#cas for more details. - * + * @see {@link https://valkey.io/commands/watch/|valkey.io} and {@link https://valkey.io/topics/transactions/#cas|Valkey Glide Wiki} for more details. * @remarks When in cluster mode, the command may route to multiple nodes when `keys` map to different hash slots. + * * @param keys - The keys to watch. * @returns A simple "OK" response. * @@ -5688,7 +5721,7 @@ export class BaseClient { * acknowledged by at least `numreplicas` of replicas. If `timeout` is reached, the command returns * the number of replicas that were not yet reached. * - * See https://valkey.io/commands/wait/ for more details. + * @see {@link https://valkey.io/commands/wait/|valkey.io} for more details. * * @param numreplicas - The number of replicas to reach. * @param timeout - The timeout value specified in milliseconds. A value of 0 will block indefinitely. @@ -5710,7 +5743,7 @@ export class BaseClient { * for the entire length of `value`. If the `offset` is larger than the current length of the string at `key`, * the string is padded with zero bytes to make `offset` fit. Creates the `key` if it doesn't exist. * - * See https://valkey.io/commands/setrange/ for more details. + * @see {@link https://valkey.io/commands/setrange/|valkey.io} for more details. * * @param key - The key of the string to update. * @param offset - The position in the string where `value` should be written. @@ -5737,7 +5770,7 @@ export class BaseClient { * Appends a `value` to a `key`. If `key` does not exist it is created and set as an empty string, * so `APPEND` will be similar to {@link set} in this special case. * - * See https://valkey.io/commands/append/ for more details. + * @see {@link https://valkey.io/commands/append/|valkey.io} for more details. * * @param key - The key of the string. * @param value - The key of the string. @@ -5762,16 +5795,15 @@ export class BaseClient { /** * Pops one or more elements from the first non-empty list from the provided `keys`. * - * See https://valkey.io/commands/lmpop/ for more details. - * + * @see {@link https://valkey.io/commands/lmpop/|valkey.io} for more details. * @remarks When in cluster mode, all `key`s must map to the same hash slot. + * @remarks Since Valkey version 7.0.0. + * * @param keys - An array of keys to lists. * @param direction - The direction based on which elements are popped from - see {@link ListDirection}. * @param count - (Optional) The maximum number of popped elements. * @returns A `Record` of key-name mapped array of popped elements. * - * since Valkey version 7.0.0. - * * @example * ```typescript * await client.lpush("testKey", ["one", "two", "three"]); @@ -5792,9 +5824,10 @@ export class BaseClient { * Blocks the connection until it pops one or more elements from the first non-empty list from the * provided `key`. `BLMPOP` is the blocking variant of {@link lmpop}. * - * See https://valkey.io/commands/blmpop/ for more details. - * + * @see {@link https://valkey.io/commands/blmpop/|valkey.io} for more details. * @remarks When in cluster mode, all `key`s must map to the same hash slot. + * @remarks Since Valkey version 7.0.0. + * * @param keys - An array of keys to lists. * @param direction - The direction based on which elements are popped from - see {@link ListDirection}. * @param timeout - The number of seconds to wait for a blocking operation to complete. A value of `0` will block indefinitely. @@ -5802,8 +5835,6 @@ export class BaseClient { * @returns - A `Record` of `key` name mapped array of popped elements. * If no member could be popped and the timeout expired, returns `null`. * - * since Valkey version 7.0.0. - * * @example * ```typescript * await client.lpush("testKey", ["one", "two", "three"]); @@ -5827,7 +5858,7 @@ export class BaseClient { * Lists the currently active channels. * The command is routed to all nodes, and aggregates the response to a single array. * - * See https://valkey.io/commands/pubsub-channels for more details. + * @see {@link https://valkey.io/commands/pubsub-channels/|valkey.io} for more details. * * @param pattern - A glob-style pattern to match active channels. * If not provided, all active channels are returned. @@ -5854,7 +5885,7 @@ export class BaseClient { * not the count of clients subscribed to patterns. * The command is routed to all nodes, and aggregates the response to the sum of all pattern subscriptions. * - * See https://valkey.io/commands/pubsub-numpat for more details. + * @see {@link https://valkey.io/commands/pubsub-numpat/|valkey.io} for more details. * * @returns The number of unique patterns. * @@ -5874,7 +5905,7 @@ export class BaseClient { * Note that it is valid to call this command without channels. In this case, it will just return an empty map. * The command is routed to all nodes, and aggregates the response to a single map of the channels and their number of subscriptions. * - * See https://valkey.io/commands/pubsub-numsub for more details. + * @see {@link https://valkey.io/commands/pubsub-numsub/|valkey.io} for more details. * * @param channels - The list of channels to query for the number of subscribers. * If not provided, returns an empty map. diff --git a/node/src/GlideClient.ts b/node/src/GlideClient.ts index ce34cbec70..e63f7f8fb1 100644 --- a/node/src/GlideClient.ts +++ b/node/src/GlideClient.ts @@ -58,7 +58,7 @@ import { Transaction } from "./Transaction"; export namespace GlideClientConfiguration { /** * Enum representing pubsub subscription modes. - * See [Valkey PubSub Documentation](https://valkey.io/docs/topics/pubsub/) for more details. + * @see {@link https://valkey.io/docs/topics/pubsub/|Valkey PubSub Documentation} for more details. */ export enum PubSubChannelModes { /** @@ -131,8 +131,8 @@ export type GlideClientConfiguration = BaseClientConfiguration & { /** * Client used for connection to standalone Redis servers. - * For full documentation, see - * https://github.com/valkey-io/valkey-glide/wiki/NodeJS-wrapper#standalone + * + * @see For full documentation refer to {@link https://github.com/valkey-io/valkey-glide/wiki/NodeJS-wrapper#standalone|Valkey Glide Wiki}. */ export class GlideClient extends BaseClient { /** @@ -169,8 +169,10 @@ export class GlideClient extends BaseClient { ); } - /** Execute a transaction by processing the queued commands. - * See https://redis.io/topics/Transactions/ for details on Redis Transactions. + /** + * Execute a transaction by processing the queued commands. + * + * @see {@link https://github.com/valkey-io/valkey-glide/wiki/NodeJS-wrapper#transaction|Valkey Glide Wiki} for details on Valkey Transactions. * * @param transaction - A Transaction object containing a list of commands to be executed. * @param decoder - (Optional) {@link Decoder} type which defines how to handle the responses. If not set, the default decoder from the client config will be used. @@ -199,8 +201,7 @@ export class GlideClient extends BaseClient { * * Note: An error will occur if the string decoder is used with commands that return only bytes as a response. * - * See the [Glide for Redis Wiki](https://github.com/valkey-io/valkey-glide/wiki/General-Concepts#custom-command) - * for details on the restrictions and limitations of the custom command API. + * @see {@link https://github.com/valkey-io/valkey-glide/wiki/General-Concepts#custom-command|Valkey Glide Wiki} for details on the restrictions and limitations of the custom command API. * * @example * ```typescript @@ -219,7 +220,7 @@ export class GlideClient extends BaseClient { } /** Ping the Redis server. - * See https://valkey.io/commands/ping/ for details. + * @see {@link https://valkey.io/commands/ping/|valkey.io} for details. * * @param message - An optional message to include in the PING command. * If not provided, the server will respond with "PONG". @@ -251,7 +252,7 @@ export class GlideClient extends BaseClient { } /** Get information and statistics about the Redis server. - * See https://valkey.io/commands/info/ for details. + * @see {@link https://valkey.io/commands/info/|valkey.io} for details. * * @param options - A list of InfoSection values specifying which sections of information to retrieve. * When no parameter is provided, the default option is assumed. @@ -262,7 +263,7 @@ export class GlideClient extends BaseClient { } /** Change the currently selected Redis database. - * See https://valkey.io/commands/select/ for details. + * @see {@link https://valkey.io/commands/select/|valkey.io} for details. * * @param index - The index of the database to select. * @returns A simple OK response. @@ -279,7 +280,7 @@ export class GlideClient extends BaseClient { } /** Get the name of the primary's connection. - * See https://valkey.io/commands/client-getname/ for more details. + * @see {@link https://valkey.io/commands/client-getname/|valkey.io} for more details. * * @returns the name of the client connection as a string if a name is set, or null if no name is assigned. * @@ -295,7 +296,7 @@ export class GlideClient extends BaseClient { } /** Rewrite the configuration file with the current configuration. - * See https://valkey.io/commands/config-rewrite/ for details. + * @see {@link https://valkey.io/commands/config-rewrite/|valkey.io} for details. * * @returns "OK" when the configuration was rewritten properly. Otherwise, an error is thrown. * @@ -311,7 +312,8 @@ export class GlideClient extends BaseClient { } /** Resets the statistics reported by Redis using the INFO and LATENCY HISTOGRAM commands. - * See https://valkey.io/commands/config-resetstat/ for details. + * + * @see {@link https://valkey.io/commands/config-resetstat/|valkey.io} for details. * * @returns always "OK". * @@ -327,7 +329,7 @@ export class GlideClient extends BaseClient { } /** Returns the current connection id. - * See https://valkey.io/commands/client-id/ for details. + * @see {@link https://valkey.io/commands/client-id/|valkey.io} for details. * * @returns the id of the client. */ @@ -336,7 +338,8 @@ export class GlideClient extends BaseClient { } /** Reads the configuration parameters of a running Redis server. - * See https://valkey.io/commands/config-get/ for details. + * + * @see {@link https://valkey.io/commands/config-get/|valkey.io} for details. * * @param parameters - A list of configuration parameter names to retrieve values for. * @@ -355,11 +358,11 @@ export class GlideClient extends BaseClient { return this.createWritePromise(createConfigGet(parameters)); } - /** Set configuration parameters to the specified values. - * See https://valkey.io/commands/config-set/ for details. + /** + * Set configuration parameters to the specified values. * + * @see {@link https://valkey.io/commands/config-set/|valkey.io} for details. * @param parameters - A List of keyValuePairs consisting of configuration parameters and their respective values to set. - * * @returns "OK" when the configuration was set properly. Otherwise an error is thrown. * * @example @@ -374,7 +377,7 @@ export class GlideClient extends BaseClient { } /** Echoes the provided `message` back. - * See https://valkey.io/commands/echo for more details. + * @see {@link https://valkey.io/commands/echo|valkey.io} for more details. * * @param message - The message to be echoed back. * @returns The provided `message`. @@ -391,7 +394,7 @@ export class GlideClient extends BaseClient { } /** Returns the server time - * See https://valkey.io/commands/time/ for details. + * @see {@link https://valkey.io/commands/time/|valkey.io} for details. * * @returns - The current server time as a two items `array`: * A Unix timestamp and the amount of microseconds already elapsed in the current second. @@ -414,7 +417,8 @@ export class GlideClient extends BaseClient { * When `replace` is true, removes the `destination` key first if it already exists, otherwise performs * no action. * - * See https://valkey.io/commands/copy/ for more details. + * @see {@link https://valkey.io/commands/copy/|valkey.io} for more details. + * @remarks Since Valkey version 6.2.0. * * @param source - The key to the source value. * @param destination - The key where the value should be copied to. @@ -424,8 +428,6 @@ export class GlideClient extends BaseClient { * value to it. If not provided, no action will be performed if the key already exists. * @returns `true` if `source` was copied, `false` if the `source` was not copied. * - * since Valkey version 6.2.0. - * * @example * ```typescript * const result = await client.copy("set1", "set2"); @@ -453,7 +455,7 @@ export class GlideClient extends BaseClient { /** * Move `key` from the currently selected database to the database specified by `dbIndex`. * - * See https://valkey.io/commands/move/ for more details. + * @see {@link https://valkey.io/commands/move/|valkey.io} for more details. * * @param key - The key to move. * @param dbIndex - The index of the database to move `key` to. @@ -473,7 +475,7 @@ export class GlideClient extends BaseClient { /** * Displays a piece of generative computer art and the server version. * - * See https://valkey.io/commands/lolwut/ for more details. + * @see {@link https://valkey.io/commands/lolwut/|valkey.io} for more details. * * @param options - The LOLWUT options * @returns A piece of generative computer art along with the current server version. @@ -491,9 +493,8 @@ export class GlideClient extends BaseClient { /** * Deletes a library and all its functions. * - * See https://valkey.io/commands/function-delete/ for details. - * - * since Valkey version 7.0.0. + * @see {@link https://valkey.io/commands/function-delete/|valkey.io} for details. + * @remarks Since Valkey version 7.0.0. * * @param libraryCode - The library name to delete. * @returns A simple OK response. @@ -511,9 +512,8 @@ export class GlideClient extends BaseClient { /** * Loads a library to Valkey. * - * See https://valkey.io/commands/function-load/ for details. - * - * since Valkey version 7.0.0. + * @see {@link https://valkey.io/commands/function-load/|valkey.io} for details. + * @remarks Since Valkey version 7.0.0. * * @param libraryCode - The source code that implements the library. * @param replace - Whether the given library should overwrite a library with the same name if it @@ -539,9 +539,8 @@ export class GlideClient extends BaseClient { /** * Deletes all function libraries. * - * See https://valkey.io/commands/function-flush/ for details. - * - * since Valkey version 7.0.0. + * @see {@link https://valkey.io/commands/function-flush/|valkey.io} for details. + * @remarks Since Valkey version 7.0.0. * * @param mode - The flushing mode, could be either {@link FlushMode.SYNC} or {@link FlushMode.ASYNC}. * @returns A simple OK response. @@ -559,9 +558,8 @@ export class GlideClient extends BaseClient { /** * Returns information about the functions and libraries. * - * See https://valkey.io/commands/function-list/ for details. - * - * since Valkey version 7.0.0. + * @see {@link https://valkey.io/commands/function-list/|valkey.io} for details. + * @remarks Since Valkey version 7.0.0. * * @param options - Parameters to filter and request additional info. * @returns Info about all or selected libraries and their functions in {@link FunctionListResponse} format. @@ -595,15 +593,13 @@ export class GlideClient extends BaseClient { * Returns information about the function that's currently running and information about the * available execution engines. * - * See https://valkey.io/commands/function-stats/ for details. - * - * since Valkey version 7.0.0. + * @see {@link https://valkey.io/commands/function-stats/|valkey.io} for details. + * @remarks Since Valkey version 7.0.0. * * @returns A `Record` with two keys: * - `"running_script"` with information about the running script. * - `"engines"` with information about available engines and their stats. - * - * See example for more details. + * - see example for more details. * * @example * ```typescript @@ -664,7 +660,7 @@ export class GlideClient extends BaseClient { /** * Deletes all the keys of all the existing databases. This command never fails. * - * See https://valkey.io/commands/flushall/ for more details. + * @see {@link https://valkey.io/commands/flushall/|valkey.io} for more details. * * @param mode - The flushing mode, could be either {@link FlushMode.SYNC} or {@link FlushMode.ASYNC}. * @returns `OK`. @@ -682,7 +678,7 @@ export class GlideClient extends BaseClient { /** * Deletes all the keys of the currently selected database. This command never fails. * - * See https://valkey.io/commands/flushdb/ for more details. + * @see {@link https://valkey.io/commands/flushdb/|valkey.io} for more details. * * @param mode - The flushing mode, could be either {@link FlushMode.SYNC} or {@link FlushMode.ASYNC}. * @returns `OK`. @@ -700,7 +696,7 @@ export class GlideClient extends BaseClient { /** * Returns the number of keys in the currently selected database. * - * See https://valkey.io/commands/dbsize/ for more details. + * @see {@link https://valkey.io/commands/dbsize/|valkey.io} for more details. * * @returns The number of keys in the currently selected database. * @@ -716,7 +712,7 @@ export class GlideClient extends BaseClient { /** Publish a message on pubsub channel. * - * See https://valkey.io/commands/publish for more details. + * @see {@link https://valkey.io/commands/publish/|valkey.io} for more details. * * @param message - Message to publish. * @param channel - Channel to publish the message on. @@ -742,7 +738,7 @@ export class GlideClient extends BaseClient { * * To store the result into a new key, see {@link sortStore}. * - * See https://valkey.io/commands/sort for more details. + * @see {@link https://valkey.io/commands/sort/|valkey.io} for more details. * * @param key - The key of the list, set, or sorted set to be sorted. * @param options - The {@link SortOptions}. @@ -772,7 +768,8 @@ export class GlideClient extends BaseClient { * * This command is routed depending on the client's {@link ReadFrom} strategy. * - * since Valkey version 7.0.0. + * @see {@link https://valkey.io/commands/sort/|valkey.io} for more details. + * @remarks Since Valkey version 7.0.0. * * @param key - The key of the list, set, or sorted set to be sorted. * @param options - The {@link SortOptions}. @@ -803,9 +800,9 @@ export class GlideClient extends BaseClient { * * To get the sort result without storing it into a key, see {@link sort} or {@link sortReadOnly}. * - * See https://valkey.io/commands/sort for more details. - * + * @see {@link https://valkey.io/commands/sort|valkey.io} for more details. * @remarks When in cluster mode, `destination` and `key` must map to the same hash slot. + * * @param key - The key of the list, set, or sorted set to be sorted. * @param destination - The key where the sorted result will be stored. * @param options - The {@link SortOptions}. @@ -833,7 +830,7 @@ export class GlideClient extends BaseClient { * Returns `UNIX TIME` of the last DB save timestamp or startup timestamp if no save * was made since then. * - * See https://valkey.io/commands/lastsave/ for more details. + * @see {@link https://valkey.io/commands/lastsave/|valkey.io} for more details. * * @returns `UNIX TIME` of the last DB save executed with success. * @example @@ -849,7 +846,7 @@ export class GlideClient extends BaseClient { /** * Returns a random existing key name from the currently selected database. * - * See https://valkey.io/commands/randomkey/ for more details. + * @see {@link https://valkey.io/commands/randomkey/|valkey.io} for more details. * * @returns A random existing key name from the currently selected database. * @@ -867,7 +864,7 @@ export class GlideClient extends BaseClient { * Flushes all the previously watched keys for a transaction. Executing a transaction will * automatically flush all previously watched keys. * - * See https://valkey.io/commands/unwatch/ and https://valkey.io/topics/transactions/#cas for more details. + * @see {@link https://valkey.io/commands/unwatch/|valkey.io} and {@link https://valkey.io/topics/transactions/#cas|Valkey Glide Wiki} for more details. * * @returns A simple "OK" response. * diff --git a/node/src/GlideClusterClient.ts b/node/src/GlideClusterClient.ts index 84f875355b..0c3698e170 100644 --- a/node/src/GlideClusterClient.ts +++ b/node/src/GlideClusterClient.ts @@ -88,7 +88,7 @@ export type PeriodicChecks = export namespace GlideClusterClientConfiguration { /** * Enum representing pubsub subscription modes. - * See [Valkey PubSub Documentation](https://valkey.io/docs/topics/pubsub/) for more details. + * @see {@link https://valkey.io/docs/topics/pubsub/|Valkey PubSub Documentation} for more details. */ export enum PubSubChannelModes { /** @@ -285,8 +285,8 @@ function toProtobufRoute( /** * Client used for connection to cluster Redis servers. - * For full documentation, see - * https://github.com/valkey-io/valkey-glide/wiki/NodeJS-wrapper#cluster + * + * @see For full documentation refer to {@link https://github.com/valkey-io/valkey-glide/wiki/NodeJS-wrapper#cluster|Valkey Glide Wiki}. */ export class GlideClusterClient extends BaseClient { /** @@ -346,8 +346,7 @@ export class GlideClusterClient extends BaseClient { * * Note: An error will occur if the string decoder is used with commands that return only bytes as a response. * - * See the [Glide for Valkey Wiki](https://github.com/valkey-io/valkey-glide/wiki/General-Concepts#custom-command) - * for details on the restrictions and limitations of the custom command API. + * @see {@link https://github.com/valkey-io/valkey-glide/wiki/General-Concepts#custom-command|Glide for Valkey Wiki} for details on the restrictions and limitations of the custom command API. * * @example * ```typescript @@ -367,8 +366,9 @@ export class GlideClusterClient extends BaseClient { }); } - /** Execute a transaction by processing the queued commands. - * See https://redis.io/topics/Transactions/ for details on Redis Transactions. + /** + * Execute a transaction by processing the queued commands. + * @see {@link https://redis.io/topics/Transactions/|Valkey Glide Wiki} for details on Redis Transactions. * * @param transaction - A ClusterTransaction object containing a list of commands to be executed. * @param route - If `route` is not provided, the transaction will be routed to the slot owner of the first key found in the transaction. @@ -401,7 +401,8 @@ export class GlideClusterClient extends BaseClient { } /** Ping the Redis server. - * See https://valkey.io/commands/ping/ for details. + * + * @see {@link https://valkey.io/commands/ping/|valkey.io} for details. * * @param message - An optional message to include in the PING command. * If not provided, the server will respond with "PONG". @@ -437,7 +438,7 @@ export class GlideClusterClient extends BaseClient { } /** Get information and statistics about the Redis server. - * See https://valkey.io/commands/info/ for details. + * @see {@link https://valkey.io/commands/info/|valkey.io} for details. * * @param options - A list of InfoSection values specifying which sections of information to retrieve. * When no parameter is provided, the default option is assumed. @@ -457,7 +458,7 @@ export class GlideClusterClient extends BaseClient { } /** Get the name of the connection to which the request is routed. - * See https://valkey.io/commands/client-getname/ for more details. + * @see {@link https://valkey.io/commands/client-getname/|valkey.io} for details. * * @param route - The command will be routed a random node, unless `route` is provided, in which * case the client will route the command to the nodes defined by `route`. @@ -490,11 +491,10 @@ export class GlideClusterClient extends BaseClient { } /** Rewrite the configuration file with the current configuration. - * See https://valkey.io/commands/config-rewrite/ for details. + * @see {@link https://valkey.io/commands/config-rewrite/|valkey.io} for details. * * @param route - The command will be routed to all nodes, unless `route` is provided, in which * case the client will route the command to the nodes defined by `route`. - * * @returns "OK" when the configuration was rewritten properly. Otherwise, an error is thrown. * * @example @@ -511,11 +511,10 @@ export class GlideClusterClient extends BaseClient { } /** Resets the statistics reported by Redis using the INFO and LATENCY HISTOGRAM commands. - * See https://valkey.io/commands/config-resetstat/ for details. + * @see {@link https://valkey.io/commands/config-resetstat/|valkey.io} for details. * * @param route - The command will be routed to all nodes, unless `route` is provided, in which * case the client will route the command to the nodes defined by `route`. - * * @returns always "OK". * * @example @@ -532,7 +531,7 @@ export class GlideClusterClient extends BaseClient { } /** Returns the current connection id. - * See https://valkey.io/commands/client-id/ for details. + * @see {@link https://valkey.io/commands/client-id/|valkey.io} for details. * * @param route - The command will be routed to a random node, unless `route` is provided, in which * case the client will route the command to the nodes defined by `route`. @@ -547,7 +546,7 @@ export class GlideClusterClient extends BaseClient { } /** Reads the configuration parameters of a running Redis server. - * See https://valkey.io/commands/config-get/ for details. + * @see {@link https://valkey.io/commands/config-get/|valkey.io} for details. * * @param parameters - A list of configuration parameter names to retrieve values for. * @param route - The command will be routed to a random node, unless `route` is provided, in which @@ -582,13 +581,12 @@ export class GlideClusterClient extends BaseClient { } /** Set configuration parameters to the specified values. - * See https://valkey.io/commands/config-set/ for details. + * @see {@link https://valkey.io/commands/config-set/|valkey.io} for details. * * @param parameters - A List of keyValuePairs consisting of configuration parameters and their respective values to set. * @param route - The command will be routed to all nodes, unless `route` is provided, in which * case the client will route the command to the nodes defined by `route`. * If `route` is not provided, the command will be sent to the all nodes. - * * @returns "OK" when the configuration was set properly. Otherwise an error is thrown. * * @example @@ -608,7 +606,7 @@ export class GlideClusterClient extends BaseClient { } /** Echoes the provided `message` back. - * See https://valkey.io/commands/echo for more details. + * @see {@link https://valkey.io/commands/echo/|valkey.io} for details. * * @param message - The message to be echoed back. * @param route - The command will be routed to a random node, unless `route` is provided, in which @@ -639,7 +637,7 @@ export class GlideClusterClient extends BaseClient { } /** Returns the server time. - * See https://valkey.io/commands/time/ for details. + * @see {@link https://valkey.io/commands/time/|valkey.io} for details. * * @param route - The command will be routed to a random node, unless `route` is provided, in which * case the client will route the command to the nodes defined by `route`. @@ -676,17 +674,16 @@ export class GlideClusterClient extends BaseClient { * Copies the value stored at the `source` to the `destination` key. When `replace` is `true`, * removes the `destination` key first if it already exists, otherwise performs no action. * - * See https://valkey.io/commands/copy/ for more details. - * + * @see {@link https://valkey.io/commands/copy/|valkey.io} for details. * @remarks When in cluster mode, `source` and `destination` must map to the same hash slot. + * @remarks Since Valkey version 6.2.0. + * * @param source - The key to the source value. * @param destination - The key where the value should be copied to. * @param replace - (Optional) If `true`, the `destination` key should be removed before copying the * value to it. If not provided, no action will be performed if the key already exists. * @returns `true` if `source` was copied, `false` if the `source` was not copied. * - * since Valkey version 6.2.0. - * * @example * ```typescript * const result = await client.copy("set1", "set2", true); @@ -706,7 +703,7 @@ export class GlideClusterClient extends BaseClient { /** * Displays a piece of generative computer art and the server version. * - * See https://valkey.io/commands/lolwut/ for more details. + * @see {@link https://valkey.io/commands/lolwut/|valkey.io} for details. * * @param options - The LOLWUT options. * @param route - The command will be routed to a random node, unless `route` is provided, in which @@ -732,9 +729,8 @@ export class GlideClusterClient extends BaseClient { /** * Invokes a previously loaded function. * - * See https://valkey.io/commands/fcall/ for more details. - * - * since Valkey version 7.0.0. + * @see {@link https://valkey.io/commands/fcall/|valkey.io} for details. + * @remarks Since Valkey version 7.0.0. * * @param func - The function name. * @param args - A list of `function` arguments and it should not represent names of keys. @@ -761,9 +757,8 @@ export class GlideClusterClient extends BaseClient { /** * Invokes a previously loaded read-only function. * - * See https://valkey.io/commands/fcall/ for more details. - * - * since Valkey version 7.0.0. + * @see {@link https://valkey.io/commands/fcall/|valkey.io} for details. + * @remarks Since Valkey version 7.0.0. * * @param func - The function name. * @param args - A list of `function` arguments and it should not represent names of keys. @@ -791,9 +786,8 @@ export class GlideClusterClient extends BaseClient { /** * Deletes a library and all its functions. * - * See https://valkey.io/commands/function-delete/ for details. - * - * since Valkey version 7.0.0. + * @see {@link https://valkey.io/commands/function-delete/|valkey.io} for details. + * @remarks Since Valkey version 7.0.0. * * @param libraryCode - The library name to delete. * @param route - The command will be routed to all primary node, unless `route` is provided, in which @@ -818,9 +812,8 @@ export class GlideClusterClient extends BaseClient { /** * Loads a library to Valkey. * - * See https://valkey.io/commands/function-load/ for details. - * - * since Valkey version 7.0.0. + * @see {@link https://valkey.io/commands/function-load/|valkey.io} for details. + * @remarks Since Valkey version 7.0.0. * * @param libraryCode - The source code that implements the library. * @param replace - Whether the given library should overwrite a library with the same name if it @@ -850,9 +843,8 @@ export class GlideClusterClient extends BaseClient { /** * Deletes all function libraries. * - * See https://valkey.io/commands/function-flush/ for details. - * - * since Valkey version 7.0.0. + * @see {@link https://valkey.io/commands/function-flush/|valkey.io} for details. + * @remarks Since Valkey version 7.0.0. * * @param mode - The flushing mode, could be either {@link FlushMode.SYNC} or {@link FlushMode.ASYNC}. * @param route - The command will be routed to all primary nodes, unless `route` is provided, in which @@ -877,9 +869,8 @@ export class GlideClusterClient extends BaseClient { /** * Returns information about the functions and libraries. * - * See https://valkey.io/commands/function-list/ for details. - * - * since Valkey version 7.0.0. + * @see {@link https://valkey.io/commands/function-list/|valkey.io} for details. + * @remarks Since Valkey version 7.0.0. * * @param options - Parameters to filter and request additional info. * @param route - The client will route the command to the nodes defined by `route`. @@ -918,17 +909,15 @@ export class GlideClusterClient extends BaseClient { * Returns information about the function that's currently running and information about the * available execution engines. * - * See https://valkey.io/commands/function-stats/ for details. - * - * since Valkey version 7.0.0. + * @see {@link https://valkey.io/commands/function-stats/|valkey.io} for details. + * @remarks Since Valkey version 7.0.0. * * @param route - The client will route the command to the nodes defined by `route`. * If not defined, the command will be routed to all primary nodes. * @returns A `Record` with two keys: * - `"running_script"` with information about the running script. * - `"engines"` with information about available engines and their stats. - * - * See example for more details. + * - See example for more details. * * @example * ```typescript @@ -976,13 +965,13 @@ export class GlideClusterClient extends BaseClient { * Kills a function that is currently executing. * `FUNCTION KILL` terminates read-only functions only. * - * See https://valkey.io/commands/function-kill/ for details. - * - * since Valkey version 7.0.0. + * @see {@link https://valkey.io/commands/function-kill/|valkey.io} for details. + * @remarks Since Valkey version 7.0.0. * * @param route - (Optional) The client will route the command to the nodes defined by `route`. * If not defined, the command will be routed to all primary nodes. * @returns `OK` if function is terminated. Otherwise, throws an error. + * * @example * ```typescript * await client.functionKill(); @@ -997,7 +986,7 @@ export class GlideClusterClient extends BaseClient { /** * Deletes all the keys of all the existing databases. This command never fails. * - * See https://valkey.io/commands/flushall/ for more details. + * @see {@link https://valkey.io/commands/flushall/|valkey.io} for details. * * @param mode - The flushing mode, could be either {@link FlushMode.SYNC} or {@link FlushMode.ASYNC}. * @param route - The command will be routed to all primary nodes, unless `route` is provided, in which @@ -1019,7 +1008,7 @@ export class GlideClusterClient extends BaseClient { /** * Deletes all the keys of the currently selected database. This command never fails. * - * See https://valkey.io/commands/flushdb/ for more details. + * @see {@link https://valkey.io/commands/flushdb/|valkey.io} for details. * * @param mode - The flushing mode, could be either {@link FlushMode.SYNC} or {@link FlushMode.ASYNC}. * @param route - The command will be routed to all primary nodes, unless `route` is provided, in which @@ -1041,7 +1030,7 @@ export class GlideClusterClient extends BaseClient { /** * Returns the number of keys in the database. * - * See https://valkey.io/commands/dbsize/ for more details. + * @see {@link https://valkey.io/commands/dbsize/|valkey.io} for details. * @param route - The command will be routed to all primary nodes, unless `route` is provided, in which * case the client will route the command to the nodes defined by `route`. @@ -1065,7 +1054,7 @@ export class GlideClusterClient extends BaseClient { * The mode is selected using the 'sharded' parameter. * For both sharded and non-sharded mode, request is routed using hashed channel as key. * - * See https://valkey.io/commands/publish and https://valkey.io/commands/spublish for more details. + * @see {@link https://valkey.io/commands/publish} and {@link https://valkey.io/commands/spublish} for more details. * * @param message - Message to publish. * @param channel - Channel to publish the message on. @@ -1100,7 +1089,7 @@ export class GlideClusterClient extends BaseClient { * Lists the currently active shard channels. * The command is routed to all nodes, and aggregates the response to a single array. * - * See https://valkey.io/commands/pubsub-shardchannels for more details. + * @see {@link https://valkey.io/commands/pubsub-shardchannels/|valkey.io} for details. * * @param pattern - A glob-style pattern to match active shard channels. * If not provided, all active shard channels are returned. @@ -1126,7 +1115,7 @@ export class GlideClusterClient extends BaseClient { * Note that it is valid to call this command without channels. In this case, it will just return an empty map. * The command is routed to all nodes, and aggregates the response to a single map of the channels and their number of subscriptions. * - * See https://valkey.io/commands/pubsub-shardnumsub for more details. + * @see {@link https://valkey.io/commands/pubsub-shardnumsub/|valkey.io} for details. * * @param channels - The list of shard channels to query for the number of subscribers. * If not provided, returns an empty map. @@ -1155,7 +1144,7 @@ export class GlideClusterClient extends BaseClient { * * To store the result into a new key, see {@link sortStore}. * - * See https://valkey.io/commands/sort for more details. + * @see {@link https://valkey.io/commands/sort/|valkey.io} for details. * * @param key - The key of the list, set, or sorted set to be sorted. * @param options - (Optional) {@link SortClusterOptions}. @@ -1183,7 +1172,7 @@ export class GlideClusterClient extends BaseClient { * * This command is routed depending on the client's {@link ReadFrom} strategy. * - * since Valkey version 7.0.0. + * @remarks Since Valkey version 7.0.0. * * @param key - The key of the list, set, or sorted set to be sorted. * @param options - (Optional) {@link SortClusterOptions}. @@ -1212,9 +1201,9 @@ export class GlideClusterClient extends BaseClient { * * To get the sort result without storing it into a key, see {@link sort} or {@link sortReadOnly}. * - * See https://valkey.io/commands/sort for more details. - * + * @see {@link https://valkey.io/commands/sort/|valkey.io} for details. * @remarks When in cluster mode, `destination` and `key` must map to the same hash slot. + * * @param key - The key of the list, set, or sorted set to be sorted. * @param destination - The key where the sorted result will be stored. * @param options - (Optional) {@link SortClusterOptions}. @@ -1240,7 +1229,7 @@ export class GlideClusterClient extends BaseClient { * Returns `UNIX TIME` of the last DB save timestamp or startup timestamp if no save * was made since then. * - * See https://valkey.io/commands/lastsave/ for more details. + * @see {@link https://valkey.io/commands/lastsave/|valkey.io} for details. * * @param route - (Optional) The command will be routed to a random node, unless `route` is provided, in which * case the client will route the command to the nodes defined by `route`. @@ -1260,7 +1249,7 @@ export class GlideClusterClient extends BaseClient { /** * Returns a random existing key name. * - * See https://valkey.io/commands/randomkey/ for more details. + * @see {@link https://valkey.io/commands/randomkey/|valkey.io} for details. * * @param route - (Optional) The command will be routed to all primary nodes, unless `route` is provided, * in which case the client will route the command to the nodes defined by `route`. @@ -1282,7 +1271,7 @@ export class GlideClusterClient extends BaseClient { * Flushes all the previously watched keys for a transaction. Executing a transaction will * automatically flush all previously watched keys. * - * See https://valkey.io/commands/unwatch/ and https://valkey.io/topics/transactions/#cas for more details. + * @see {@link https://valkey.io/commands/unwatch/|valkey.io} and {@link https://valkey.io/topics/transactions/#cas|Valkey Glide Wiki} for more details. * * @param route - (Optional) The command will be routed to all primary nodes, unless `route` is provided, * in which case the client will route the command to the nodes defined by `route`. diff --git a/node/src/Transaction.ts b/node/src/Transaction.ts index 7ac86a8f48..b24d4f8973 100644 --- a/node/src/Transaction.ts +++ b/node/src/Transaction.ts @@ -296,8 +296,7 @@ export class BaseTransaction> { } /** Get the value associated with the given key, or null if no such value exists. - * - * See https://valkey.io/commands/get/ for details. + * @see {@link https://valkey.io/commands/get/|valkey.io} for details. * * @param key - The key to retrieve from the database. * @@ -309,15 +308,15 @@ export class BaseTransaction> { /** * Get the value of `key` and optionally set its expiration. `GETEX` is similar to {@link get}. - * See https://valkey.io/commands/getex for more details. + * + * @see {@link https://valkey.io/commands/getex/|valkey.io} for more details. + * @remarks Since Valkey version 6.2.0. * * @param key - The key to retrieve from the database. * @param options - (Optional) set expiriation to the given key. * "persist" will retain the time to live associated with the key. Equivalent to `PERSIST` in the VALKEY API. * Otherwise, a {@link TimeUnit} and duration of the expire time should be specified. * - * since - Valkey 6.2.0 and above. - * * Command Response - If `key` exists, returns the value of `key` as a `string`. Otherwise, return `null`. */ public getex( @@ -330,7 +329,7 @@ export class BaseTransaction> { /** * Gets a string value associated with the given `key`and deletes the key. * - * See https://valkey.io/commands/getdel/ for details. + * @see {@link https://valkey.io/commands/getdel/|valkey.io} for details. * * @param key - The key to retrieve from the database. * @@ -347,7 +346,7 @@ export class BaseTransaction> { * penultimate and so forth. If `key` does not exist, an empty string is returned. If `start` * or `end` are out of range, returns the substring within the valid range of the string. * - * See https://valkey.io/commands/getrange/ for details. + * @see {@link https://valkey.io/commands/getrange/|valkey.io} for details. * * @param key - The key of the string. * @param start - The starting offset. @@ -360,7 +359,7 @@ export class BaseTransaction> { } /** Set the given key with the given value. Return value is dependent on the passed options. - * See https://valkey.io/commands/set/ for details. + * @see {@link https://valkey.io/commands/set/|valkey.io} for details. * * @param key - The key to store. * @param value - The value to store with the given key. @@ -375,7 +374,7 @@ export class BaseTransaction> { } /** Ping the Redis server. - * See https://valkey.io/commands/ping/ for details. + * @see {@link https://valkey.io/commands/ping/|valkey.io} for details. * * @param message - An optional message to include in the PING command. * If not provided, the server will respond with "PONG". @@ -388,7 +387,7 @@ export class BaseTransaction> { } /** Get information and statistics about the Redis server. - * See https://valkey.io/commands/info/ for details. + * @see {@link https://valkey.io/commands/info/|valkey.io} for details. * * @param options - A list of InfoSection values specifying which sections of information to retrieve. * When no parameter is provided, the default option is assumed. @@ -400,7 +399,7 @@ export class BaseTransaction> { } /** Remove the specified keys. A key is ignored if it does not exist. - * See https://valkey.io/commands/del/ for details. + * @see {@link https://valkey.io/commands/del/|valkey.io} for details. * * @param keys - A list of keys to be deleted from the database. * @@ -411,7 +410,7 @@ export class BaseTransaction> { } /** Get the name of the connection on which the transaction is being executed. - * See https://valkey.io/commands/client-getname/ for more details. + * @see {@link https://valkey.io/commands/client-getname/|valkey.io} for details. * * Command Response - the name of the client connection as a string if a name is set, or null if no name is assigned. */ @@ -420,7 +419,7 @@ export class BaseTransaction> { } /** Rewrite the configuration file with the current configuration. - * See https://valkey.io/commands/select/ for details. + * @see {@link https://valkey.io/commands/select/|valkey.io} for details. * * Command Response - "OK" when the configuration was rewritten properly. Otherwise, the transaction fails with an error. */ @@ -429,7 +428,7 @@ export class BaseTransaction> { } /** Resets the statistics reported by Redis using the INFO and LATENCY HISTOGRAM commands. - * See https://valkey.io/commands/config-resetstat/ for details. + * @see {@link https://valkey.io/commands/config-resetstat/|valkey.io} for details. * * Command Response - always "OK". */ @@ -438,7 +437,7 @@ export class BaseTransaction> { } /** Retrieve the values of multiple keys. - * See https://valkey.io/commands/mget/ for details. + * @see {@link https://valkey.io/commands/mget/|valkey.io} for details. * * @param keys - A list of keys to retrieve values for. * @@ -450,7 +449,7 @@ export class BaseTransaction> { } /** Set multiple keys to multiple values in a single atomic operation. - * See https://valkey.io/commands/mset/ for details. + * @see {@link https://valkey.io/commands/mset/|valkey.io} for details. * * @param keyValueMap - A key-value map consisting of keys and their respective values to set. * @@ -464,7 +463,7 @@ export class BaseTransaction> { * Sets multiple keys to values if the key does not exist. The operation is atomic, and if one or * more keys already exist, the entire operation fails. * - * See https://valkey.io/commands/msetnx/ for more details. + * @see {@link https://valkey.io/commands/msetnx/|valkey.io} for details. * * @param keyValueMap - A key-value map consisting of keys and their respective values to set. * Command Response - `true` if all keys were set. `false` if no key was set. @@ -474,7 +473,7 @@ export class BaseTransaction> { } /** Increments the number stored at `key` by one. If `key` does not exist, it is set to 0 before performing the operation. - * See https://valkey.io/commands/incr/ for details. + * @see {@link https://valkey.io/commands/incr/|valkey.io} for details. * * @param key - The key to increment its value. * @@ -485,7 +484,7 @@ export class BaseTransaction> { } /** Increments the number stored at `key` by `amount`. If `key` does not exist, it is set to 0 before performing the operation. - * See https://valkey.io/commands/incrby/ for details. + * @see {@link https://valkey.io/commands/incrby/|valkey.io} for details. * * @param key - The key to increment its value. * @param amount - The amount to increment. @@ -499,7 +498,7 @@ export class BaseTransaction> { /** Increment the string representing a floating point number stored at `key` by `amount`. * By using a negative amount value, the result is that the value stored at `key` is decremented. * If `key` does not exist, it is set to 0 before performing the operation. - * See https://valkey.io/commands/incrbyfloat/ for details. + * @see {@link https://valkey.io/commands/incrbyfloat/|valkey.io} for details. * * @param key - The key to increment its value. * @param amount - The amount to increment. @@ -512,7 +511,7 @@ export class BaseTransaction> { } /** Returns the current connection id. - * See https://valkey.io/commands/client-id/ for details. + * @see {@link https://valkey.io/commands/client-id/|valkey.io} for details. * * Command Response - the id of the client. */ @@ -521,7 +520,7 @@ export class BaseTransaction> { } /** Decrements the number stored at `key` by one. If `key` does not exist, it is set to 0 before performing the operation. - * See https://valkey.io/commands/decr/ for details. + * @see {@link https://valkey.io/commands/decr/|valkey.io} for details. * * @param key - The key to decrement its value. * @@ -532,7 +531,7 @@ export class BaseTransaction> { } /** Decrements the number stored at `key` by `amount`. If `key` does not exist, it is set to 0 before performing the operation. - * See https://valkey.io/commands/decrby/ for details. + * @see {@link https://valkey.io/commands/decrby/|valkey.io} for details. * * @param key - The key to decrement its value. * @param amount - The amount to decrement. @@ -547,7 +546,7 @@ export class BaseTransaction> { * Perform a bitwise operation between multiple keys (containing string values) and store the result in the * `destination`. * - * See https://valkey.io/commands/bitop/ for more details. + * @see {@link https://valkey.io/commands/bitop/|valkey.io} for details. * * @param operation - The bitwise operation to perform. * @param destination - The key that will store the resulting string. @@ -567,7 +566,7 @@ export class BaseTransaction> { * Returns the bit value at `offset` in the string value stored at `key`. `offset` must be greater than or equal * to zero. * - * See https://valkey.io/commands/getbit/ for more details. + * @see {@link https://valkey.io/commands/getbit/|valkey.io} for details. * * @param key - The key of the string. * @param offset - The index of the bit to return. @@ -585,7 +584,7 @@ export class BaseTransaction> { * `2^32` and greater than or equal to `0`. If a key is non-existent then the bit at `offset` is set to `value` and * the preceding bits are set to `0`. * - * See https://valkey.io/commands/setbit/ for more details. + * @see {@link https://valkey.io/commands/setbit/|valkey.io} for details. * * @param key - The key of the string. * @param offset - The index of the bit to be set. @@ -603,7 +602,7 @@ export class BaseTransaction> { * The offset can also be a negative number indicating an offset starting at the end of the list, with `-1` being * the last byte of the list, `-2` being the penultimate, and so on. * - * See https://valkey.io/commands/bitpos/ for more details. + * @see {@link https://valkey.io/commands/bitpos/|valkey.io} for details. * * @param key - The key of the string. * @param bit - The bit value to match. Must be `0` or `1`. @@ -627,7 +626,7 @@ export class BaseTransaction> { * are assumed. If BIT is specified, `start=0` and `end=2` means to look at the first three bits. If BYTE is * specified, `start=0` and `end=2` means to look at the first three bytes. * - * See https://valkey.io/commands/bitpos/ for more details. + * @see {@link https://valkey.io/commands/bitpos/|valkey.io} for details. * * @param key - The key of the string. * @param bit - The bit value to match. Must be `0` or `1`. @@ -654,7 +653,7 @@ export class BaseTransaction> { * Reads or modifies the array of bits representing the string that is held at `key` based on the specified * `subcommands`. * - * See https://valkey.io/commands/bitfield/ for more details. + * @see {@link https://valkey.io/commands/bitfield/|valkey.io} for details. * * @param key - The key of the string. * @param subcommands - The subcommands to be performed on the binary value of the string at `key`, which could be @@ -681,21 +680,21 @@ export class BaseTransaction> { /** * Reads the array of bits representing the string that is held at `key` based on the specified `subcommands`. * - * See https://valkey.io/commands/bitfield_ro/ for more details. + * @see {@link https://valkey.io/commands/bitfield_ro/|valkey.io} for details. + * @remarks Since Valkey version 6.0.0. * * @param key - The key of the string. * @param subcommands - The {@link BitFieldGet} subcommands to be performed. * * Command Response - An array of results from the {@link BitFieldGet} subcommands. * - * since Valkey version 6.0.0. */ public bitfieldReadOnly(key: string, subcommands: BitFieldGet[]): T { return this.addAndReturn(createBitField(key, subcommands, true)); } /** Reads the configuration parameters of a running Redis server. - * See https://valkey.io/commands/config-get/ for details. + * @see {@link https://valkey.io/commands/config-get/|valkey.io} for details. * * @param parameters - A list of configuration parameter names to retrieve values for. * @@ -707,7 +706,7 @@ export class BaseTransaction> { } /** Set configuration parameters to the specified values. - * See https://valkey.io/commands/config-set/ for details. + * @see {@link https://valkey.io/commands/config-set/|valkey.io} for details. * * @param parameters - A List of keyValuePairs consisting of configuration parameters and their respective values to set. * @@ -718,7 +717,7 @@ export class BaseTransaction> { } /** Retrieve the value associated with `field` in the hash stored at `key`. - * See https://valkey.io/commands/hget/ for details. + * @see {@link https://valkey.io/commands/hget/|valkey.io} for details. * * @param key - The key of the hash. * @param field - The field in the hash stored at `key` to retrieve from the database. @@ -730,7 +729,7 @@ export class BaseTransaction> { } /** Sets the specified fields to their respective values in the hash stored at `key`. - * See https://valkey.io/commands/hset/ for details. + * @see {@link https://valkey.io/commands/hset/|valkey.io} for details. * * @param key - The key of the hash. * @param fieldValueMap - A field-value map consisting of fields and their corresponding values @@ -745,7 +744,7 @@ export class BaseTransaction> { /** Sets `field` in the hash stored at `key` to `value`, only if `field` does not yet exist. * If `key` does not exist, a new key holding a hash is created. * If `field` already exists, this operation has no effect. - * See https://valkey.io/commands/hsetnx/ for more details. + * @see {@link https://valkey.io/commands/hsetnx/|valkey.io} for details. * * @param key - The key of the hash. * @param field - The field to set the value for. @@ -759,7 +758,7 @@ export class BaseTransaction> { /** Removes the specified fields from the hash stored at `key`. * Specified fields that do not exist within this hash are ignored. - * See https://valkey.io/commands/hdel/ for details. + * @see {@link https://valkey.io/commands/hdel/|valkey.io} for details. * * @param key - The key of the hash. * @param fields - The fields to remove from the hash stored at `key`. @@ -772,7 +771,7 @@ export class BaseTransaction> { } /** Returns the values associated with the specified fields in the hash stored at `key`. - * See https://valkey.io/commands/hmget/ for details. + * @see {@link https://valkey.io/commands/hmget/|valkey.io} for details. * * @param key - The key of the hash. * @param fields - The fields in the hash stored at `key` to retrieve from the database. @@ -786,7 +785,7 @@ export class BaseTransaction> { } /** Returns if `field` is an existing field in the hash stored at `key`. - * See https://valkey.io/commands/hexists/ for details. + * @see {@link https://valkey.io/commands/hexists/|valkey.io} for details. * * @param key - The key of the hash. * @param field - The field to check in the hash stored at `key`. @@ -799,7 +798,7 @@ export class BaseTransaction> { } /** Returns all fields and values of the hash stored at `key`. - * See https://valkey.io/commands/hgetall/ for details. + * @see {@link https://valkey.io/commands/hgetall/|valkey.io} for details. * * @param key - The key of the hash. * @@ -813,7 +812,7 @@ export class BaseTransaction> { /** Increments the number stored at `field` in the hash stored at `key` by `increment`. * By using a negative increment value, the value stored at `field` in the hash stored at `key` is decremented. * If `field` or `key` does not exist, it is set to 0 before performing the operation. - * See https://valkey.io/commands/hincrby/ for details. + * @see {@link https://valkey.io/commands/hincrby/|valkey.io} for details. * * @param key - The key of the hash. * @param amount - The amount to increment. @@ -828,7 +827,7 @@ export class BaseTransaction> { /** Increment the string representing a floating point number stored at `field` in the hash stored at `key` by `increment`. * By using a negative increment value, the value stored at `field` in the hash stored at `key` is decremented. * If `field` or `key` does not exist, it is set to 0 before performing the operation. - * See https://valkey.io/commands/hincrbyfloat/ for details. + * @see {@link https://valkey.io/commands/hincrbyfloat/|valkey.io} for details. * * @param key - The key of the hash. * @param amount - The amount to increment. @@ -841,7 +840,7 @@ export class BaseTransaction> { } /** Returns the number of fields contained in the hash stored at `key`. - * See https://valkey.io/commands/hlen/ for more details. + * @see {@link https://valkey.io/commands/hlen/|valkey.io} for details. * * @param key - The key of the hash. * @@ -852,7 +851,7 @@ export class BaseTransaction> { } /** Returns all values in the hash stored at key. - * See https://valkey.io/commands/hvals/ for more details. + * @see {@link https://valkey.io/commands/hvals/|valkey.io} for details. * * @param key - The key of the hash. * @@ -865,7 +864,7 @@ export class BaseTransaction> { /** * Returns the string length of the value associated with `field` in the hash stored at `key`. * - * See https://valkey.io/commands/hstrlen/ for details. + * @see {@link https://valkey.io/commands/hstrlen/|valkey.io} for details. * * @param key - The key of the hash. * @param field - The field in the hash. @@ -879,9 +878,8 @@ export class BaseTransaction> { /** * Returns a random field name from the hash value stored at `key`. * - * See https://valkey.io/commands/hrandfield/ for more details. - * - * since Valkey version 6.2.0. + * @see {@link https://valkey.io/commands/hrandfield/|valkey.io} for details. + * @remarks Since Valkey version 6.2.0. * * @param key - The key of the hash. * @@ -895,7 +893,7 @@ export class BaseTransaction> { /** * Iterates incrementally over a hash. * - * See https://valkey.io/commands/hscan for more details. + * @see {@link https://valkey.io/commands/hscan/|valkey.io} for more details. * * @param key - The key of the set. * @param cursor - The cursor that points to the next iteration of results. A value of `"0"` indicates the start of the search. @@ -914,9 +912,8 @@ export class BaseTransaction> { /** * Retrieves up to `count` random field names from the hash value stored at `key`. * - * See https://valkey.io/commands/hrandfield/ for more details. - * - * since Valkey version 6.2.0. + * @see {@link https://valkey.io/commands/hrandfield/|valkey.io} for details. + * @remarks Since Valkey version 6.2.0. * * @param key - The key of the hash. * @param count - The number of field names to return. @@ -934,9 +931,8 @@ export class BaseTransaction> { * Retrieves up to `count` random field names along with their values from the hash * value stored at `key`. * - * See https://valkey.io/commands/hrandfield/ for more details. - * - * since Valkey version 6.2.0. + * @see {@link https://valkey.io/commands/hrandfield/|valkey.io} for details. + * @remarks Since Valkey version 6.2.0. * * @param key - The key of the hash. * @param count - The number of field names to return. @@ -954,7 +950,7 @@ export class BaseTransaction> { /** Inserts all the specified values at the head of the list stored at `key`. * `elements` are inserted one after the other to the head of the list, from the leftmost element to the rightmost element. * If `key` does not exist, it is created as empty list before performing the push operations. - * See https://valkey.io/commands/lpush/ for details. + * @see {@link https://valkey.io/commands/lpush/|valkey.io} for details. * * @param key - The key of the list. * @param elements - The elements to insert at the head of the list stored at `key`. @@ -969,7 +965,7 @@ export class BaseTransaction> { * Inserts specified values at the head of the `list`, only if `key` already * exists and holds a list. * - * See https://valkey.io/commands/lpushx/ for details. + * @see {@link https://valkey.io/commands/lpushx/|valkey.io} for details. * * @param key - The key of the list. * @param elements - The elements to insert at the head of the list stored at `key`. @@ -982,7 +978,7 @@ export class BaseTransaction> { /** Removes and returns the first elements of the list stored at `key`. * The command pops a single element from the beginning of the list. - * See https://valkey.io/commands/lpop/ for details. + * @see {@link https://valkey.io/commands/lpop/|valkey.io} for details. * * @param key - The key of the list. * @@ -994,7 +990,7 @@ export class BaseTransaction> { } /** Removes and returns up to `count` elements of the list stored at `key`, depending on the list's length. - * See https://valkey.io/commands/lpop/ for details. + * @see {@link https://valkey.io/commands/lpop/|valkey.io} for details. * * @param key - The key of the list. * @param count - The count of the elements to pop from the list. @@ -1010,7 +1006,7 @@ export class BaseTransaction> { * The offsets `start` and `end` are zero-based indexes, with 0 being the first element of the list, 1 being the next element and so on. * These offsets can also be negative numbers indicating offsets starting at the end of the list, * with -1 being the last element of the list, -2 being the penultimate, and so on. - * See https://valkey.io/commands/lrange/ for details. + * @see {@link https://valkey.io/commands/lrange/|valkey.io} for details. * * @param key - The key of the list. * @param start - The starting point of the range. @@ -1026,7 +1022,7 @@ export class BaseTransaction> { } /** Returns the length of the list stored at `key`. - * See https://valkey.io/commands/llen/ for details. + * @see {@link https://valkey.io/commands/llen/|valkey.io} for details. * * @param key - The key of the list. * @@ -1042,7 +1038,8 @@ export class BaseTransaction> { * depending on `whereFrom`, and pushes the element at the first/last element of the list * stored at `destination` depending on `whereTo`, see {@link ListDirection}. * - * See https://valkey.io/commands/lmove/ for details. + * @see {@link https://valkey.io/commands/lmove/|valkey.io} for details. + * @remarks Since Valkey version 6.2.0. * * @param source - The key to the source list. * @param destination - The key to the destination list. @@ -1050,8 +1047,6 @@ export class BaseTransaction> { * @param whereTo - The {@link ListDirection} to add the element to. * * Command Response - The popped element, or `null` if `source` does not exist. - * - * since Valkey version 6.2.0. */ public lmove( source: string, @@ -1071,11 +1066,10 @@ export class BaseTransaction> { * of the list stored at `destination` depending on `whereTo`. * `BLMOVE` is the blocking variant of {@link lmove}. * - * @remarks - * 1. When in cluster mode, both `source` and `destination` must map to the same hash slot. - * 2. `BLMOVE` is a client blocking command, see https://github.com/aws/glide-for-redis/wiki/General-Concepts#blocking-commands for more details and best practices. - * - * See https://valkey.io/commands/blmove/ for details. + * @see {@link https://valkey.io/commands/blmove/|valkey.io} for details. + * @remarks When in cluster mode, both `source` and `destination` must map to the same hash slot. + * @remarks `BLMOVE` is a client blocking command, see {@link https://github.com/valkey-io/valkey-glide/wiki/General-Concepts#blocking-commands|Valkey Glide Wiki} for more details and best practices. + * @remarks Since Valkey version 6.2.0. * * @param source - The key to the source list. * @param destination - The key to the destination list. @@ -1084,8 +1078,6 @@ export class BaseTransaction> { * @param timeout - The number of seconds to wait for a blocking operation to complete. A value of `0` will block indefinitely. * * Command Response - The popped element, or `null` if `source` does not exist or if the operation timed-out. - * - * since Valkey version 6.2.0. */ public blmove( source: string, @@ -1105,7 +1097,7 @@ export class BaseTransaction> { * Negative indices can be used to designate elements starting at the tail of * the list. Here, `-1` means the last element, `-2` means the penultimate and so forth. * - * See https://valkey.io/commands/lset/ for details. + * @see {@link https://valkey.io/commands/lset/|valkey.io} for details. * * @param key - The key of the list. * @param index - The index of the element in the list to be set. @@ -1121,7 +1113,7 @@ export class BaseTransaction> { * The offsets `start` and `end` are zero-based indexes, with 0 being the first element of the list, 1 being the next element and so on. * These offsets can also be negative numbers indicating offsets starting at the end of the list, * with -1 being the last element of the list, -2 being the penultimate, and so on. - * See https://valkey.io/commands/ltrim/ for details. + * @see {@link https://valkey.io/commands/ltrim/|valkey.io} for details. * * @param key - The key of the list. * @param start - The starting point of the range. @@ -1155,7 +1147,7 @@ export class BaseTransaction> { /** Inserts all the specified values at the tail of the list stored at `key`. * `elements` are inserted one after the other to the tail of the list, from the leftmost element to the rightmost element. * If `key` does not exist, it is created as empty list before performing the push operations. - * See https://valkey.io/commands/rpush/ for details. + * @see {@link https://valkey.io/commands/rpush/|valkey.io} for details. * * @param key - The key of the list. * @param elements - The elements to insert at the tail of the list stored at `key`. @@ -1170,7 +1162,7 @@ export class BaseTransaction> { * Inserts specified values at the tail of the `list`, only if `key` already * exists and holds a list. * - * See https://valkey.io/commands/rpushx/ for details. + * @see {@link https://valkey.io/commands/rpushx/|valkey.io} for details. * * @param key - The key of the list. * @param elements - The elements to insert at the tail of the list stored at `key`. @@ -1183,7 +1175,7 @@ export class BaseTransaction> { /** Removes and returns the last elements of the list stored at `key`. * The command pops a single element from the end of the list. - * See https://valkey.io/commands/rpop/ for details. + * @see {@link https://valkey.io/commands/rpop/|valkey.io} for details. * * @param key - The key of the list. * @@ -1195,7 +1187,7 @@ export class BaseTransaction> { } /** Removes and returns up to `count` elements from the list stored at `key`, depending on the list's length. - * See https://valkey.io/commands/rpop/ for details. + * @see {@link https://valkey.io/commands/rpop/|valkey.io} for details. * * @param key - The key of the list. * @param count - The count of the elements to pop from the list. @@ -1209,7 +1201,7 @@ export class BaseTransaction> { /** Adds the specified members to the set stored at `key`. Specified members that are already a member of this set are ignored. * If `key` does not exist, a new set is created before adding `members`. - * See https://valkey.io/commands/sadd/ for details. + * @see {@link https://valkey.io/commands/sadd/|valkey.io} for details. * * @param key - The key to store the members to its set. * @param members - A list of members to add to the set stored at `key`. @@ -1221,7 +1213,7 @@ export class BaseTransaction> { } /** Removes the specified members from the set stored at `key`. Specified members that are not a member of this set are ignored. - * See https://valkey.io/commands/srem/ for details. + * @see {@link https://valkey.io/commands/srem/|valkey.io} for details. * * @param key - The key to remove the members from its set. * @param members - A list of members to remove from the set stored at `key`. @@ -1234,7 +1226,7 @@ export class BaseTransaction> { } /** Returns all the members of the set value stored at `key`. - * See https://valkey.io/commands/smembers/ for details. + * @see {@link https://valkey.io/commands/smembers/|valkey.io} for details. * * @param key - The key to return its members. * @@ -1247,7 +1239,7 @@ export class BaseTransaction> { /** Moves `member` from the set at `source` to the set at `destination`, removing it from the source set. * Creates a new destination set if needed. The operation is atomic. - * See https://valkey.io/commands/smove for more details. + * @see {@link https://valkey.io/commands/smove/|valkey.io} for more details. * * @param source - The key of the set to remove the element from. * @param destination - The key of the set to add the element to. @@ -1260,7 +1252,7 @@ export class BaseTransaction> { } /** Returns the set cardinality (number of elements) of the set stored at `key`. - * See https://valkey.io/commands/scard/ for details. + * @see {@link https://valkey.io/commands/scard/|valkey.io} for details. * * @param key - The key to return the number of its members. * @@ -1272,7 +1264,7 @@ export class BaseTransaction> { /** Gets the intersection of all the given sets. * When in cluster mode, all `keys` must map to the same hash slot. - * See https://valkey.io/docs/latest/commands/sinter/ for more details. + * @see {@link https://valkey.io/commands/sinter/|valkey.io} for details. * * @param keys - The `keys` of the sets to get the intersection. * @@ -1286,13 +1278,12 @@ export class BaseTransaction> { /** * Gets the cardinality of the intersection of all the given sets. * - * See https://valkey.io/commands/sintercard/ for more details. + * @see {@link https://valkey.io/commands/sintercard/|valkey.io} for details. + * @remarks Since Valkey version 7.0.0. * * @param keys - The keys of the sets. * * Command Response - The cardinality of the intersection result. If one or more sets do not exist, `0` is returned. - * - * since Valkey version 7.0.0. */ public sintercard(keys: string[], limit?: number): T { return this.addAndReturn(createSInterCard(keys, limit)); @@ -1301,7 +1292,7 @@ export class BaseTransaction> { /** * Stores the members of the intersection of all given sets specified by `keys` into a new set at `destination`. * - * See https://valkey.io/commands/sinterstore/ for more details. + * @see {@link https://valkey.io/commands/sinterstore/|valkey.io} for details. * * @param destination - The key of the destination set. * @param keys - The keys from which to retrieve the set members. @@ -1315,7 +1306,7 @@ export class BaseTransaction> { /** * Computes the difference between the first set and all the successive sets in `keys`. * - * See https://valkey.io/commands/sdiff/ for more details. + * @see {@link https://valkey.io/commands/sdiff/|valkey.io} for details. * * @param keys - The keys of the sets to diff. * @@ -1329,7 +1320,7 @@ export class BaseTransaction> { /** * Stores the difference between the first set and all the successive sets in `keys` into a new set at `destination`. * - * See https://valkey.io/commands/sdiffstore/ for more details. + * @see {@link https://valkey.io/commands/sdiffstore/|valkey.io} for details. * * @param destination - The key of the destination set. * @param keys - The keys of the sets to diff. @@ -1343,7 +1334,7 @@ export class BaseTransaction> { /** * Gets the union of all the given sets. * - * See https://valkey.io/commands/sunion/ for more details. + * @see {@link https://valkey.io/commands/sunion/|valkey.io} for details. * * @param keys - The keys of the sets. * @@ -1358,7 +1349,7 @@ export class BaseTransaction> { * Stores the members of the union of all given sets specified by `keys` into a new set * at `destination`. * - * See https://valkey.io/commands/sunionstore/ for details. + * @see {@link https://valkey.io/commands/sunionstore/|valkey.io} for details. * * @param destination - The key of the destination set. * @param keys - The keys from which to retrieve the set members. @@ -1370,7 +1361,7 @@ export class BaseTransaction> { } /** Returns if `member` is a member of the set stored at `key`. - * See https://valkey.io/commands/sismember/ for more details. + * @see {@link https://valkey.io/commands/sismember/|valkey.io} for details. * * @param key - The key of the set. * @param member - The member to check for existence in the set. @@ -1385,21 +1376,20 @@ export class BaseTransaction> { /** * Checks whether each member is contained in the members of the set stored at `key`. * - * See https://valkey.io/commands/smismember/ for more details. + * @see {@link https://valkey.io/commands/smismember/|valkey.io} for details. + * @remarks Since Valkey version 6.2.0. * * @param key - The key of the set to check. * @param members - A list of members to check for existence in the set. * * Command Response - An `array` of `boolean` values, each indicating if the respective member exists in the set. - * - * since Valkey version 6.2.0. */ public smismember(key: string, members: string[]): T { return this.addAndReturn(createSMIsMember(key, members)); } /** Removes and returns one random member from the set value store at `key`. - * See https://valkey.io/commands/spop/ for details. + * @see {@link https://valkey.io/commands/spop/|valkey.io} for details. * To pop multiple members, see `spopCount`. * * @param key - The key of the set. @@ -1412,7 +1402,7 @@ export class BaseTransaction> { } /** Removes and returns up to `count` random members from the set value store at `key`, depending on the set's length. - * See https://valkey.io/commands/spop/ for details. + * @see {@link https://valkey.io/commands/spop/|valkey.io} for details. * * @param key - The key of the set. * @param count - The count of the elements to pop from the set. @@ -1426,7 +1416,7 @@ export class BaseTransaction> { /** Returns a random element from the set value stored at `key`. * - * See https://valkey.io/commands/srandmember for more details. + * @see {@link https://valkey.io/commands/srandmember/|valkey.io} for more details. * * @param key - The key from which to retrieve the set member. * Command Response - A random element from the set, or null if `key` does not exist. @@ -1437,7 +1427,7 @@ export class BaseTransaction> { /** Returns one or more random elements from the set value stored at `key`. * - * See https://valkey.io/commands/srandmember for more details. + * @see {@link https://valkey.io/commands/srandmember/|valkey.io} for more details. * * @param key - The key of the sorted set. * @param count - The number of members to return. @@ -1450,7 +1440,7 @@ export class BaseTransaction> { } /** Returns the number of keys in `keys` that exist in the database. - * See https://valkey.io/commands/exists/ for details. + * @see {@link https://valkey.io/commands/exists/|valkey.io} for details. * * @param keys - The keys list to check. * @@ -1464,7 +1454,7 @@ export class BaseTransaction> { /** Removes the specified keys. A key is ignored if it does not exist. * This command, similar to DEL, removes specified keys and ignores non-existent ones. * However, this command does not block the server, while [DEL](https://valkey.io/commands/del) does. - * See https://valkey.io/commands/unlink/ for details. + * @see {@link https://valkey.io/commands/unlink/|valkey.io} for details. * * @param keys - The keys we wanted to unlink. * @@ -1478,7 +1468,7 @@ export class BaseTransaction> { * If `key` already has an existing expire set, the time to live is updated to the new value. * If `seconds` is non-positive number, the key will be deleted rather than expired. * The timeout will only be cleared by commands that delete or overwrite the contents of `key`. - * See https://valkey.io/commands/expire/ for details. + * @see {@link https://valkey.io/commands/expire/|valkey.io} for details. * * @param key - The key to set timeout on it. * @param seconds - The timeout in seconds. @@ -1495,7 +1485,7 @@ export class BaseTransaction> { * A timestamp in the past will delete the key immediately. After the timeout has expired, the key will automatically be deleted. * If `key` already has an existing expire set, the time to live is updated to the new value. * The timeout will only be cleared by commands that delete or overwrite the contents of `key`. - * See https://valkey.io/commands/expireat/ for details. + * @see {@link https://valkey.io/commands/expireat/|valkey.io} for details. * * @param key - The key to set timeout on it. * @param unixSeconds - The timeout in an absolute Unix timestamp. @@ -1516,13 +1506,12 @@ export class BaseTransaction> { * Returns the absolute Unix timestamp (since January 1, 1970) at which the given `key` will expire, in seconds. * To get the expiration with millisecond precision, use {@link pexpiretime}. * - * See https://valkey.io/commands/expiretime/ for details. + * @see {@link https://valkey.io/commands/expiretime/|valkey.io} for details. + * @remarks Since Valkey version 7.0.0. * * @param key - The `key` to determine the expiration value of. * * Command Response - The expiration Unix timestamp in seconds, `-2` if `key` does not exist or `-1` if `key` exists but has no associated expire. - * - * since Valkey version 7.0.0. */ public expireTime(key: string): T { return this.addAndReturn(createExpireTime(key)); @@ -1532,7 +1521,7 @@ export class BaseTransaction> { * If `key` already has an existing expire set, the time to live is updated to the new value. * If `milliseconds` is non-positive number, the key will be deleted rather than expired. * The timeout will only be cleared by commands that delete or overwrite the contents of `key`. - * See https://valkey.io/commands/pexpire/ for details. + * @see {@link https://valkey.io/commands/pexpire/|valkey.io} for details. * * @param key - The key to set timeout on it. * @param milliseconds - The timeout in milliseconds. @@ -1553,7 +1542,7 @@ export class BaseTransaction> { * A timestamp in the past will delete the key immediately. After the timeout has expired, the key will automatically be deleted. * If `key` already has an existing expire set, the time to live is updated to the new value. * The timeout will only be cleared by commands that delete or overwrite the contents of `key`. - * See https://valkey.io/commands/pexpireat/ for details. + * @see {@link https://valkey.io/commands/pexpireat/|valkey.io} for details. * * @param key - The key to set timeout on it. * @param unixMilliseconds - The timeout in an absolute Unix timestamp. @@ -1575,20 +1564,19 @@ export class BaseTransaction> { /** * Returns the absolute Unix timestamp (since January 1, 1970) at which the given `key` will expire, in milliseconds. * - * See https://valkey.io/commands/pexpiretime/ for details. + * @see {@link https://valkey.io/commands/pexpiretime/|valkey.io} for details. + * @remarks Since Valkey version 7.0.0. * * @param key - The `key` to determine the expiration value of. * * Command Response - The expiration Unix timestamp in seconds, `-2` if `key` does not exist or `-1` if `key` exists but has no associated expire. - * - * since Valkey version 7.0.0. */ public pexpireTime(key: string): T { return this.addAndReturn(createPExpireTime(key)); } /** Returns the remaining time to live of `key` that has a timeout. - * See https://valkey.io/commands/ttl/ for details. + * @see {@link https://valkey.io/commands/ttl/|valkey.io} for details. * * @param key - The key to return its timeout. * @@ -1600,7 +1588,7 @@ export class BaseTransaction> { /** Adds members with their scores to the sorted set stored at `key`. * If a member is already a part of the sorted set, its score is updated. - * See https://valkey.io/commands/zadd/ for more details. + * @see {@link https://valkey.io/commands/zadd/|valkey.io} for details. * * @param key - The key of the sorted set. * @param membersScoresMap - A mapping of members to their corresponding scores. @@ -1620,7 +1608,7 @@ export class BaseTransaction> { /** Increments the score of member in the sorted set stored at `key` by `increment`. * If `member` does not exist in the sorted set, it is added with `increment` as its score (as if its previous score was 0.0). * If `key` does not exist, a new sorted set with the specified member as its sole member is created. - * See https://valkey.io/commands/zadd/ for more details. + * @see {@link https://valkey.io/commands/zadd/|valkey.io} for details. * * @param key - The key of the sorted set. * @param member - A member in the sorted set to increment. @@ -1643,7 +1631,7 @@ export class BaseTransaction> { /** Removes the specified members from the sorted set stored at `key`. * Specified members that are not a member of this set are ignored. - * See https://valkey.io/commands/zrem/ for more details. + * @see {@link https://valkey.io/commands/zrem/|valkey.io} for details. * * @param key - The key of the sorted set. * @param members - A list of members to remove from the sorted set. @@ -1656,7 +1644,7 @@ export class BaseTransaction> { } /** Returns the cardinality (number of elements) of the sorted set stored at `key`. - * See https://valkey.io/commands/zcard/ for more details. + * @see {@link https://valkey.io/commands/zcard/|valkey.io} for details. * * @param key - The key of the sorted set. * @@ -1670,15 +1658,14 @@ export class BaseTransaction> { /** * Returns the cardinality of the intersection of the sorted sets specified by `keys`. * - * See https://valkey.io/commands/zintercard/ for more details. + * @see {@link https://valkey.io/commands/zintercard/|valkey.io} for details. + * @remarks Since Valkey version 7.0.0. * * @param keys - The keys of the sorted sets to intersect. * @param limit - An optional argument that can be used to specify a maximum number for the * intersection cardinality. If limit is not supplied, or if it is set to `0`, there will be no limit. * * Command Response - The cardinality of the intersection of the given sorted sets. - * - * since - Redis version 7.0.0. */ public zintercard(keys: string[], limit?: number): T { return this.addAndReturn(createZInterCard(keys, limit)); @@ -1688,14 +1675,13 @@ export class BaseTransaction> { * Returns the difference between the first sorted set and all the successive sorted sets. * To get the elements with their scores, see {@link zdiffWithScores}. * - * See https://valkey.io/commands/zdiff/ for more details. + * @see {@link https://valkey.io/commands/zdiff/|valkey.io} for details. + * @remarks Since Valkey version 6.2.0. * * @param keys - The keys of the sorted sets. * * Command Response - An `array` of elements representing the difference between the sorted sets. * If the first key does not exist, it is treated as an empty sorted set, and the command returns an empty `array`. - * - * since Valkey version 6.2.0. */ public zdiff(keys: string[]): T { return this.addAndReturn(createZDiff(keys)); @@ -1705,14 +1691,13 @@ export class BaseTransaction> { * Returns the difference between the first sorted set and all the successive sorted sets, with the associated * scores. * - * See https://valkey.io/commands/zdiff/ for more details. + * @see {@link https://valkey.io/commands/zdiff/|valkey.io} for details. + * @remarks Since Valkey version 6.2.0. * * @param keys - The keys of the sorted sets. * * Command Response - A map of elements and their scores representing the difference between the sorted sets. * If the first key does not exist, it is treated as an empty sorted set, and the command returns an empty `array`. - * - * since Valkey version 6.2.0. */ public zdiffWithScores(keys: string[]): T { return this.addAndReturn(createZDiffWithScores(keys)); @@ -1723,21 +1708,20 @@ export class BaseTransaction> { * the difference as a sorted set to `destination`, overwriting it if it already exists. Non-existent keys are * treated as empty sets. * - * See https://valkey.io/commands/zdiffstore/ for more details. + * @see {@link https://valkey.io/commands/zdiffstore/|valkey.io} for details. + * @remarks Since Valkey version 6.2.0. * * @param destination - The key for the resulting sorted set. * @param keys - The keys of the sorted sets to compare. * * Command Response - The number of members in the resulting sorted set stored at `destination`. - * - * since Valkey version 6.2.0. */ public zdiffstore(destination: string, keys: string[]): T { return this.addAndReturn(createZDiffStore(destination, keys)); } /** Returns the score of `member` in the sorted set stored at `key`. - * See https://valkey.io/commands/zscore/ for more details. + * @see {@link https://valkey.io/commands/zscore/|valkey.io} for details. * * @param key - The key of the sorted set. * @param member - The member whose score is to be retrieved. @@ -1753,22 +1737,21 @@ export class BaseTransaction> { /** * Returns the scores associated with the specified `members` in the sorted set stored at `key`. * - * See https://valkey.io/commands/zmscore/ for more details. + * @see {@link https://valkey.io/commands/zmscore/|valkey.io} for details. + * @remarks Since Valkey version 6.2.0. * * @param key - The key of the sorted set. * @param members - A list of members in the sorted set. * * Command Response - An `array` of scores corresponding to `members`. * If a member does not exist in the sorted set, the corresponding value in the list will be `null`. - * - * since Valkey version 6.2.0. */ public zmscore(key: string, members: string[]): T { return this.addAndReturn(createZMScore(key, members)); } /** Returns the number of members in the sorted set stored at `key` with scores between `minScore` and `maxScore`. - * See https://valkey.io/commands/zcount/ for more details. + * @see {@link https://valkey.io/commands/zcount/|valkey.io} for details. * * @param key - The key of the sorted set. * @param minScore - The minimum score to count from. Can be positive/negative infinity, or specific score and inclusivity. @@ -1789,7 +1772,7 @@ export class BaseTransaction> { /** Returns the specified range of elements in the sorted set stored at `key`. * ZRANGE can perform different types of range queries: by index (rank), by the score, or by lexicographical order. * - * See https://valkey.io/commands/zrange/ for more details. + * @see {@link https://valkey.io/commands/zrange/|valkey.io} for details. * To get the elements with their scores, see `zrangeWithScores`. * * @param key - The key of the sorted set. @@ -1812,7 +1795,7 @@ export class BaseTransaction> { /** Returns the specified range of elements with their scores in the sorted set stored at `key`. * Similar to ZRANGE but with a WITHSCORE flag. - * See https://valkey.io/commands/zrange/ for more details. + * @see {@link https://valkey.io/commands/zrange/|valkey.io} for details. * * @param key - The key of the sorted set. * @param rangeQuery - The range query object representing the type of range query to perform. @@ -1839,7 +1822,8 @@ export class BaseTransaction> { * sorted set at `destination`. If `destination` doesn't exist, a new sorted * set is created; if it exists, it's overwritten. * - * See https://valkey.io/commands/zrangestore/ for more details. + * @see {@link https://valkey.io/commands/zrangestore/|valkey.io} for details. + * @remarks Since Valkey version 6.2.0. * * @param destination - The key for the destination sorted set. * @param source - The key of the source sorted set. @@ -1850,8 +1834,6 @@ export class BaseTransaction> { * @param reverse - If `true`, reverses the sorted set, with index `0` as the element with the highest score. * * Command Response - The number of elements in the resulting sorted set. - * - * since - Redis version 6.2.0. */ public zrangeStore( destination: string, @@ -1870,7 +1852,7 @@ export class BaseTransaction> { * * When in cluster mode, `destination` and all keys in `keys` must map to the same hash slot. * - * See https://valkey.io/commands/zinterstore/ for more details. + * @see {@link https://valkey.io/commands/zinterstore/|valkey.io} for details. * * @param destination - The key of the destination sorted set. * @param keys - The keys of the sorted sets with possible formats: @@ -1892,7 +1874,7 @@ export class BaseTransaction> { /** * Returns a random member from the sorted set stored at `key`. * - * See https://valkey.io/commands/zrandmember/ for more details. + * @see {@link https://valkey.io/commands/zrandmember/|valkey.io} for details. * * @param keys - The key of the sorted set. * Command Response - A string representing a random member from the sorted set. @@ -1905,7 +1887,7 @@ export class BaseTransaction> { /** * Returns random members from the sorted set stored at `key`. * - * See https://valkey.io/commands/zrandmember/ for more details. + * @see {@link https://valkey.io/commands/zrandmember/|valkey.io} for details. * * @param keys - The key of the sorted set. * @param count - The number of members to return. @@ -1921,7 +1903,7 @@ export class BaseTransaction> { /** * Returns random members with scores from the sorted set stored at `key`. * - * See https://valkey.io/commands/zrandmember/ for more details. + * @see {@link https://valkey.io/commands/zrandmember/|valkey.io} for details. * * @param keys - The key of the sorted set. * @param count - The number of members to return. @@ -1936,7 +1918,7 @@ export class BaseTransaction> { } /** Returns the string representation of the type of the value stored at `key`. - * See https://valkey.io/commands/type/ for more details. + * @see {@link https://valkey.io/commands/type/|valkey.io} for details. * * @param key - The key to check its data type. * @@ -1947,7 +1929,7 @@ export class BaseTransaction> { } /** Returns the length of the string value stored at `key`. - * See https://valkey.io/commands/strlen/ for more details. + * @see {@link https://valkey.io/commands/strlen/|valkey.io} for details. * * @param key - The `key` to check its length. * @@ -1961,7 +1943,7 @@ export class BaseTransaction> { /** Removes and returns the members with the lowest scores from the sorted set stored at `key`. * If `count` is provided, up to `count` members with the lowest scores are removed and returned. * Otherwise, only one member with the lowest score is removed and returned. - * See https://valkey.io/commands/zpopmin for more details. + * @see {@link https://valkey.io/commands/zpopmin/|valkey.io} for more details. * * @param key - The key of the sorted set. * @param count - Specifies the quantity of members to pop. If not specified, pops one member. @@ -1980,11 +1962,11 @@ export class BaseTransaction> { * are provided. * `BZPOPMIN` is the blocking variant of {@link zpopmin}. * - * See https://valkey.io/commands/bzpopmin/ for more details. + * @see {@link https://valkey.io/commands/bzpopmin/|valkey.io} for details. * * @param keys - The keys of the sorted sets. * @param timeout - The number of seconds to wait for a blocking operation to complete. A value of - * `0` will block indefinitely. Since 6.0.0: timeout is interpreted as a double instead of an integer. + * `0` will block indefinitely. Since Valkey version 6.0.0: timeout is interpreted as a double instead of an integer. * * Command Response - An `array` containing the key where the member was popped out, the member, itself, and the member score. * If no member could be popped and the `timeout` expired, returns `null`. @@ -1996,7 +1978,7 @@ export class BaseTransaction> { /** Removes and returns the members with the highest scores from the sorted set stored at `key`. * If `count` is provided, up to `count` members with the highest scores are removed and returned. * Otherwise, only one member with the highest score is removed and returned. - * See https://valkey.io/commands/zpopmax for more details. + * @see {@link https://valkey.io/commands/zpopmax/|valkey.io} for more details. * * @param key - The key of the sorted set. * @param count - Specifies the quantity of members to pop. If not specified, pops one member. @@ -2015,7 +1997,7 @@ export class BaseTransaction> { * are provided. * `BZPOPMAX` is the blocking variant of {@link zpopmax}. * - * See https://valkey.io/commands/bzpopmax/ for more details. + * @see {@link https://valkey.io/commands/bzpopmax/|valkey.io} for details. * * @param keys - The keys of the sorted sets. * @param timeout - The number of seconds to wait for a blocking operation to complete. A value of @@ -2029,7 +2011,7 @@ export class BaseTransaction> { } /** Echoes the provided `message` back. - * See https://valkey.io/commands/echo for more details. + * @see {@link https://valkey.io/commands/echo/|valkey.io} for more details. * * @param message - The message to be echoed back. * @@ -2040,7 +2022,7 @@ export class BaseTransaction> { } /** Returns the remaining time to live of `key` that has a timeout, in milliseconds. - * See https://valkey.io/commands/pttl for more details. + * @see {@link https://valkey.io/commands/pttl/|valkey.io} for more details. * * @param key - The key to return its timeout. * @@ -2053,7 +2035,7 @@ export class BaseTransaction> { /** Removes all elements in the sorted set stored at `key` with rank between `start` and `end`. * Both `start` and `end` are zero-based indexes with 0 being the element with the lowest score. * These indexes can be negative numbers, where they indicate offsets starting at the element with the highest score. - * See https://valkey.io/commands/zremrangebyrank/ for more details. + * @see {@link https://valkey.io/commands/zremrangebyrank/|valkey.io} for details. * * @param key - The key of the sorted set. * @param start - The starting point of the range. @@ -2071,7 +2053,7 @@ export class BaseTransaction> { /** * Removes all elements in the sorted set stored at `key` with lexicographical order between `minLex` and `maxLex`. * - * See https://valkey.io/commands/zremrangebylex/ for more details. + * @see {@link https://valkey.io/commands/zremrangebylex/|valkey.io} for details. * * @param key - The key of the sorted set. * @param minLex - The minimum lex to count from. Can be positive/negative infinity, or a specific lex and inclusivity. @@ -2090,7 +2072,7 @@ export class BaseTransaction> { } /** Removes all elements in the sorted set stored at `key` with a score between `minScore` and `maxScore`. - * See https://valkey.io/commands/zremrangebyscore/ for more details. + * @see {@link https://valkey.io/commands/zremrangebyscore/|valkey.io} for details. * * @param key - The key of the sorted set. * @param minScore - The minimum score to remove from. Can be positive/negative infinity, or specific score and inclusivity. @@ -2113,7 +2095,7 @@ export class BaseTransaction> { /** * Returns the number of members in the sorted set stored at 'key' with scores between 'minLex' and 'maxLex'. * - * See https://valkey.io/commands/zlexcount/ for more details. + * @see {@link https://valkey.io/commands/zlexcount/|valkey.io} for details. * * @param key - The key of the sorted set. * @param minLex - The minimum lex to count from. Can be positive/negative infinity, or a specific lex and inclusivity. @@ -2132,7 +2114,7 @@ export class BaseTransaction> { } /** Returns the rank of `member` in the sorted set stored at `key`, with scores ordered from low to high. - * See https://valkey.io/commands/zrank for more details. + * @see {@link https://valkey.io/commands/zrank/|valkey.io} for more details. * To get the rank of `member` with its score, see `zrankWithScore`. * * @param key - The key of the sorted set. @@ -2146,15 +2128,15 @@ export class BaseTransaction> { } /** Returns the rank of `member` in the sorted set stored at `key` with its score, where scores are ordered from the lowest to highest. - * See https://valkey.io/commands/zrank for more details. + * + * @see {@link https://valkey.io/commands/zrank/|valkey.io} for more details. + * @remarks Since Valkey version 7.2.0. * * @param key - The key of the sorted set. * @param member - The member whose rank is to be retrieved. * * Command Response - A list containing the rank and score of `member` in the sorted set. * If `key` doesn't exist, or if `member` is not present in the set, null will be returned. - * - * since - Redis version 7.2.0. */ public zrankWithScore(key: string, member: string): T { return this.addAndReturn(createZRank(key, member, true)); @@ -2165,7 +2147,7 @@ export class BaseTransaction> { * scores are ordered from the highest to lowest, starting from 0. * To get the rank of `member` with its score, see {@link zrevrankWithScore}. * - * See https://valkey.io/commands/zrevrank/ for more details. + * @see {@link https://valkey.io/commands/zrevrank/|valkey.io} for details. * * @param key - The key of the sorted set. * @param member - The member whose rank is to be retrieved. @@ -2181,7 +2163,8 @@ export class BaseTransaction> { * Returns the rank of `member` in the sorted set stored at `key` with its * score, where scores are ordered from the highest to lowest, starting from 0. * - * See https://valkey.io/commands/zrevrank/ for more details. + * @see {@link https://valkey.io/commands/zrevrank/|valkey.io} for details. + * @remarks Since Valkey version 7.2.0. * * @param key - The key of the sorted set. * @param member - The member whose rank is to be retrieved. @@ -2189,8 +2172,6 @@ export class BaseTransaction> { * Command Response - A list containing the rank and score of `member` in the sorted set, where ranks * are ordered from high to low based on scores. * If `key` doesn't exist, or if `member` is not present in the set, `null` will be returned. - * - * since - Valkey version 7.2.0. */ public zrevrankWithScore(key: string, member: string): T { return this.addAndReturn(createZRevRankWithScore(key, member)); @@ -2198,7 +2179,7 @@ export class BaseTransaction> { /** Remove the existing timeout on `key`, turning the key from volatile (a key with an expire set) to * persistent (a key that will never expire as no timeout is associated). - * See https://valkey.io/commands/persist/ for more details. + * @see {@link https://valkey.io/commands/persist/|valkey.io} for details. * * @param key - The key to remove the existing timeout on. * @@ -2211,8 +2192,7 @@ export class BaseTransaction> { /** Executes a single command, without checking inputs. Every part of the command, including subcommands, * should be added as a separate value in args. * - * See the [Glide for Redis Wiki](https://github.com/valkey-io/valkey-glide/wiki/General-Concepts#custom-command) - * for details on the restrictions and limitations of the custom command API. + * @see {@link https://github.com/valkey-io/valkey-glide/wiki/General-Concepts#custom-command|Valkey Glide Wiki} for details on the restrictions and limitations of the custom command API. * * Command Response - A response from Redis with an `Object`. */ @@ -2224,7 +2204,7 @@ export class BaseTransaction> { * The index is zero-based, so 0 means the first element, 1 the second element and so on. * Negative indices can be used to designate elements starting at the tail of the list. * Here, -1 means the last element, -2 means the penultimate and so forth. - * See https://valkey.io/commands/lindex/ for more details. + * @see {@link https://valkey.io/commands/lindex/|valkey.io} for details. * * @param key - The `key` of the list. * @param index - The `index` of the element in the list to retrieve. @@ -2238,7 +2218,7 @@ export class BaseTransaction> { /** * Inserts `element` in the list at `key` either before or after the `pivot`. * - * See https://valkey.io/commands/linsert/ for more details. + * @see {@link https://valkey.io/commands/linsert/|valkey.io} for details. * * @param key - The key of the list. * @param position - The relative position to insert into - either `InsertPosition.Before` or @@ -2261,7 +2241,7 @@ export class BaseTransaction> { /** * Adds an entry to the specified stream stored at `key`. If the `key` doesn't exist, the stream is created. - * See https://valkey.io/commands/xadd/ for more details. + * @see {@link https://valkey.io/commands/xadd/|valkey.io} for details. * * @param key - The key of the stream. * @param values - field-value pairs to be added to the entry. @@ -2280,7 +2260,7 @@ export class BaseTransaction> { /** * Removes the specified entries by id from a stream, and returns the number of entries deleted. * - * See https://valkey.io/commands/xdel for more details. + * @see {@link https://valkey.io/commands/xdel/|valkey.io} for more details. * * @param key - The key of the stream. * @param ids - An array of entry ids. @@ -2294,7 +2274,7 @@ export class BaseTransaction> { /** * Trims the stream stored at `key` by evicting older entries. - * See https://valkey.io/commands/xtrim/ for more details. + * @see {@link https://valkey.io/commands/xtrim/|valkey.io} for details. * * @param key - the key of the stream * @param options - options detailing how to trim the stream. @@ -2321,7 +2301,7 @@ export class BaseTransaction> { } /** Returns the server time. - * See https://valkey.io/commands/time/ for details. + * @see {@link https://valkey.io/commands/time/|valkey.io} for details. * * Command Response - The current server time as a two items `array`: * A Unix timestamp and the amount of microseconds already elapsed in the current second. @@ -2334,7 +2314,7 @@ export class BaseTransaction> { /** * Returns stream entries matching a given range of entry IDs. * - * See https://valkey.io/commands/xrange for more details. + * @see {@link https://valkey.io/commands/xrange/|valkey.io} for more details. * * @param key - The key of the stream. * @param start - The starting stream entry ID bound for the range. @@ -2361,7 +2341,7 @@ export class BaseTransaction> { /** * Reads entries from the given streams. - * See https://valkey.io/commands/xread/ for more details. + * @see {@link https://valkey.io/commands/xread/|valkey.io} for details. * * @param keys_and_ids - pairs of keys and entry ids to read from. A pair is composed of a stream's key and the id of the entry after which the stream will be read. * @param options - options detailing how to read the stream. @@ -2378,7 +2358,7 @@ export class BaseTransaction> { /** * Returns the number of entries in the stream stored at `key`. * - * See https://valkey.io/commands/xlen/ for more details. + * @see {@link https://valkey.io/commands/xlen/|valkey.io} for details. * * @param key - The key of the stream. * @@ -2391,11 +2371,11 @@ export class BaseTransaction> { /** * Returns stream message summary information for pending messages matching a given range of IDs. * - * See https://valkey.io/commands/xpending/ for more details. + * @see {@link https://valkey.io/commands/xpending/|valkey.io} for details. * Returns the list of all consumers and their attributes for the given consumer group of the * stream stored at `key`. * - * See https://valkey.io/commands/xinfo-consumers/ for more details. + * @see {@link https://valkey.io/commands/xinfo-consumers/|valkey.io} for details. * * @param key - The key of the stream. * @param group - The consumer group name. @@ -2410,7 +2390,7 @@ export class BaseTransaction> { /** * Returns stream message summary information for pending messages matching a given range of IDs. * - * See https://valkey.io/commands/xpending/ for more details. + * @see {@link https://valkey.io/commands/xpending/|valkey.io} for details. * * @param key - The key of the stream. * @param group - The consumer group name. @@ -2431,7 +2411,7 @@ export class BaseTransaction> { * Returns the list of all consumers and their attributes for the given consumer group of the * stream stored at `key`. * - * See https://valkey.io/commands/xinfo-consumers/ for more details. + * @see {@link https://valkey.io/commands/xinfo-consumers/|valkey.io} for details. * * Command Response - An `Array` of `Records`, where each mapping contains the attributes * of a consumer for the given consumer group of the stream at `key`. @@ -2443,7 +2423,7 @@ export class BaseTransaction> { /** * Changes the ownership of a pending message. * - * See https://valkey.io/commands/xclaim/ for more details. + * @see {@link https://valkey.io/commands/xclaim/|valkey.io} for details. * * @param key - The key of the stream. * @param group - The consumer group name. @@ -2471,7 +2451,7 @@ export class BaseTransaction> { * Changes the ownership of a pending message. This function returns an `array` with * only the message/entry IDs, and is equivalent to using `JUSTID` in the Valkey API. * - * See https://valkey.io/commands/xclaim/ for more details. + * @see {@link https://valkey.io/commands/xclaim/|valkey.io} for details. * * @param key - The key of the stream. * @param group - The consumer group name. @@ -2498,9 +2478,8 @@ export class BaseTransaction> { /** * Transfers ownership of pending stream entries that match the specified criteria. * - * See https://valkey.io/commands/xautoclaim/ for more details. - * - * since Valkey version 6.2.0. + * @see {@link https://valkey.io/commands/xautoclaim/|valkey.io} for more details. + * @remarks Since Valkey version 6.2.0. * * @param key - The key of the stream. * @param group - The consumer group name. @@ -2535,9 +2514,8 @@ export class BaseTransaction> { /** * Transfers ownership of pending stream entries that match the specified criteria. * - * See https://valkey.io/commands/xautoclaim/ for more details. - * - * since Valkey version 6.2.0. + * @see {@link https://valkey.io/commands/xautoclaim/|valkey.io} for more details. + * @remarks Since Valkey version 6.2.0. * * @param key - The key of the stream. * @param group - The consumer group name. @@ -2581,7 +2559,7 @@ export class BaseTransaction> { * Creates a new consumer group uniquely identified by `groupname` for the stream * stored at `key`. * - * See https://valkey.io/commands/xgroup-create/ for more details. + * @see {@link https://valkey.io/commands/xgroup-create/|valkey.io} for details. * * @param key - The key of the stream. * @param groupName - The newly created consumer group name. @@ -2604,7 +2582,7 @@ export class BaseTransaction> { /** * Destroys the consumer group `groupname` for the stream stored at `key`. * - * See https://valkey.io/commands/xgroup-destroy/ for more details. + * @see {@link https://valkey.io/commands/xgroup-destroy/|valkey.io} for details. * * @param key - The key of the stream. * @param groupname - The newly created consumer group name. @@ -2618,7 +2596,7 @@ export class BaseTransaction> { /** * Creates a consumer named `consumerName` in the consumer group `groupName` for the stream stored at `key`. * - * See https://valkey.io/commands/xgroup-createconsumer for more details. + * @see {@link https://valkey.io/commands/xgroup-createconsumer/|valkey.io} for more details. * * @param key - The key of the stream. * @param groupName - The consumer group name. @@ -2639,7 +2617,7 @@ export class BaseTransaction> { /** * Deletes a consumer named `consumerName` in the consumer group `groupName` for the stream stored at `key`. * - * See https://valkey.io/commands/xgroup-delconsumer for more details. + * @see {@link https://valkey.io/commands/xgroup-delconsumer/|valkey.io} for more details. * * @param key - The key of the stream. * @param groupName - The consumer group name. @@ -2662,10 +2640,12 @@ export class BaseTransaction> { * If `newkey` already exists it is overwritten. * In Cluster mode, both `key` and `newkey` must be in the same hash slot, * meaning that in practice only keys that have the same hash tag can be reliably renamed in cluster. - * See https://valkey.io/commands/rename/ for more details. + * + * @see {@link https://valkey.io/commands/rename/|valkey.io} for details. * * @param key - The key to rename. * @param newKey - The new name of the key. + * * Command Response - If the `key` was successfully renamed, return "OK". If `key` does not exist, an error is thrown. */ public rename(key: string, newKey: string): T { @@ -2676,7 +2656,8 @@ export class BaseTransaction> { * Renames `key` to `newkey` if `newkey` does not yet exist. * In Cluster mode, both `key` and `newkey` must be in the same hash slot, * meaning that in practice only keys that have the same hash tag can be reliably renamed in cluster. - * See https://valkey.io/commands/renamenx/ for more details. + * + * @see {@link https://valkey.io/commands/renamenx/|valkey.io} for details. * * @param key - The key to rename. * @param newKey - The new name of the key. @@ -2691,12 +2672,13 @@ export class BaseTransaction> { * Pop an element from the tail of the first list that is non-empty, * with the given `keys` being checked in the order that they are given. * Blocks the connection when there are no elements to pop from any of the given lists. - * See https://valkey.io/commands/brpop/ for more details. - * Note: `BRPOP` is a blocking command, - * see [Blocking Commands](https://github.com/valkey-io/valkey-glide/wiki/General-Concepts#blocking-commands) for more details and best practices. + * + * @see {@link https://valkey.io/commands/brpop/|valkey.io} for details. + * @remarks `BRPOP` is a blocking command, see [Blocking Commands](https://github.com/valkey-io/valkey-glide/wiki/General-Concepts#blocking-commands) for more details and best practices. * * @param keys - The `keys` of the lists to pop from. * @param timeout - The `timeout` in seconds. + * * Command Response - An `array` containing the `key` from which the element was popped and the value of the popped element, * formatted as [key, value]. If no element could be popped and the timeout expired, returns `null`. */ @@ -2708,12 +2690,13 @@ export class BaseTransaction> { * Pop an element from the head of the first list that is non-empty, * with the given `keys` being checked in the order that they are given. * Blocks the connection when there are no elements to pop from any of the given lists. - * See https://valkey.io/commands/blpop/ for more details. - * Note: `BLPOP` is a blocking command, - * see [Blocking Commands](https://github.com/valkey-io/valkey-glide/wiki/General-Concepts#blocking-commands) for more details and best practices. + * + * @see {@link https://valkey.io/commands/blpop/|valkey.io} for details. + * @remarks `BLPOP` is a blocking command, see [Blocking Commands](https://github.com/valkey-io/valkey-glide/wiki/General-Concepts#blocking-commands) for more details and best practices. * * @param keys - The `keys` of the lists to pop from. * @param timeout - The `timeout` in seconds. + * * Command Response - An `array` containing the `key` from which the element was popped and the value of the popped element, * formatted as [key, value]. If no element could be popped and the timeout expired, returns `null`. */ @@ -2725,7 +2708,7 @@ export class BaseTransaction> { * Creates a new structure if the `key` does not exist. * When no elements are provided, and `key` exists and is a HyperLogLog, then no operation is performed. * - * See https://valkey.io/commands/pfadd/ for more details. + * @see {@link https://valkey.io/commands/pfadd/|valkey.io} for details. * * @param key - The key of the HyperLogLog data structure to add elements into. * @param elements - An array of members to add to the HyperLogLog stored at `key`. @@ -2739,7 +2722,7 @@ export class BaseTransaction> { /** Estimates the cardinality of the data stored in a HyperLogLog structure for a single key or * calculates the combined cardinality of multiple keys by merging their HyperLogLogs temporarily. * - * See https://valkey.io/commands/pfcount/ for more details. + * @see {@link https://valkey.io/commands/pfcount/|valkey.io} for details. * * @param keys - The keys of the HyperLogLog data structures to be analyzed. * Command Response - The approximated cardinality of given HyperLogLog data structures. @@ -2753,7 +2736,7 @@ export class BaseTransaction> { * Merges multiple HyperLogLog values into a unique value. If the destination variable exists, it is * treated as one of the source HyperLogLog data sets, otherwise a new HyperLogLog is created. * - * See https://valkey.io/commands/pfmerge/ for more details. + * @see {@link https://valkey.io/commands/pfmerge/|valkey.io} for details. * * @param destination - The key of the destination HyperLogLog where the merged data sets will be stored. * @param sourceKeys - The keys of the HyperLogLog structures to be merged. @@ -2765,7 +2748,7 @@ export class BaseTransaction> { /** Returns the internal encoding for the Redis object stored at `key`. * - * See https://valkey.io/commands/object-encoding for more details. + * @see {@link https://valkey.io/commands/object-encoding/|valkey.io} for more details. * * @param key - The `key` of the object to get the internal encoding of. * Command Response - If `key` exists, returns the internal encoding of the object stored at `key` as a string. @@ -2777,7 +2760,7 @@ export class BaseTransaction> { /** Returns the logarithmic access frequency counter of a Redis object stored at `key`. * - * See https://valkey.io/commands/object-freq for more details. + * @see {@link https://valkey.io/commands/object-freq/|valkey.io} for more details. * * @param key - The `key` of the object to get the logarithmic access frequency counter of. * Command Response - If `key` exists, returns the logarithmic access frequency counter of @@ -2790,7 +2773,7 @@ export class BaseTransaction> { /** * Returns the time in seconds since the last access to the value stored at `key`. * - * See https://valkey.io/commands/object-idletime/ for more details. + * @see {@link https://valkey.io/commands/object-idletime/|valkey.io} for details. * * @param key - The key of the object to get the idle time of. * @@ -2803,7 +2786,7 @@ export class BaseTransaction> { /** * Returns the reference count of the object stored at `key`. * - * See https://valkey.io/commands/object-refcount/ for more details. + * @see {@link https://valkey.io/commands/object-refcount/|valkey.io} for details. * * @param key - The `key` of the object to get the reference count of. * @@ -2817,7 +2800,7 @@ export class BaseTransaction> { /** * Displays a piece of generative computer art and the server version. * - * See https://valkey.io/commands/lolwut/ for more details. + * @see {@link https://valkey.io/commands/lolwut/|valkey.io} for details. * * @param options - The LOLWUT options. * @@ -2832,7 +2815,7 @@ export class BaseTransaction> { * acknowledged by at least `numreplicas` of replicas. If `timeout` is reached, the command returns * the number of replicas that were not yet reached. * - * See https://valkey.io/commands/wait/ for more details. + * @see {@link https://valkey.io/commands/wait/|valkey.io} for more details. * * @param numreplicas - The number of replicas to reach. * @param timeout - The timeout value specified in milliseconds. A value of 0 will block indefinitely. @@ -2847,9 +2830,8 @@ export class BaseTransaction> { /** * Invokes a previously loaded function. * - * See https://valkey.io/commands/fcall/ for more details. - * - * since Valkey version 7.0.0. + * @see {@link https://valkey.io/commands/fcall/|valkey.io} for details. + * @remarks Since Valkey version 7.0.0. * * @param func - The function name. * @param keys - A list of `keys` accessed by the function. To ensure the correct execution of functions, @@ -2865,9 +2847,8 @@ export class BaseTransaction> { /** * Invokes a previously loaded read-only function. * - * See https://valkey.io/commands/fcall/ for more details. - * - * since Valkey version 7.0.0. + * @see {@link https://valkey.io/commands/fcall/|valkey.io} for details. + * @remarks Since Valkey version 7.0.0. * * @param func - The function name. * @param keys - A list of `keys` accessed by the function. To ensure the correct execution of functions, @@ -2883,9 +2864,8 @@ export class BaseTransaction> { /** * Deletes a library and all its functions. * - * See https://valkey.io/commands/function-delete/ for details. - * - * since Valkey version 7.0.0. + * @see {@link https://valkey.io/commands/function-delete/|valkey.io} for details. + * @remarks Since Valkey version 7.0.0. * * @param libraryCode - The library name to delete. * @@ -2898,9 +2878,8 @@ export class BaseTransaction> { /** * Loads a library to Valkey. * - * See https://valkey.io/commands/function-load/ for details. - * - * since Valkey version 7.0.0. + * @see {@link https://valkey.io/commands/function-load/|valkey.io} for details. + * @remarks Since Valkey version 7.0.0. * * @param libraryCode - The source code that implements the library. * @param replace - Whether the given library should overwrite a library with the same name if it @@ -2915,9 +2894,8 @@ export class BaseTransaction> { /** * Deletes all function libraries. * - * See https://valkey.io/commands/function-flush/ for details. - * - * since Valkey version 7.0.0. + * @see {@link https://valkey.io/commands/function-flush/|valkey.io} for details. + * @remarks Since Valkey version 7.0.0. * * @param mode - The flushing mode, could be either {@link FlushMode.SYNC} or {@link FlushMode.ASYNC}. * Command Response - `OK`. @@ -2929,9 +2907,8 @@ export class BaseTransaction> { /** * Returns information about the functions and libraries. * - * See https://valkey.io/commands/function-list/ for details. - * - * since Valkey version 7.0.0. + * @see {@link https://valkey.io/commands/function-list/|valkey.io} for details. + * @remarks Since Valkey version 7.0.0. * * @param options - Parameters to filter and request additional info. * @@ -2945,9 +2922,8 @@ export class BaseTransaction> { * Returns information about the function that's currently running and information about the * available execution engines. * - * See https://valkey.io/commands/function-stats/ for details. - * - * since Valkey version 7.0.0. + * @see {@link https://valkey.io/commands/function-stats/|valkey.io} for details. + * @remarks Since Valkey version 7.0.0. * * Command Response - A `Record` of type {@link FunctionStatsResponse} with two keys: * @@ -2961,7 +2937,7 @@ export class BaseTransaction> { /** * Deletes all the keys of all the existing databases. This command never fails. * - * See https://valkey.io/commands/flushall/ for more details. + * @see {@link https://valkey.io/commands/flushall/|valkey.io} for details. * * @param mode - The flushing mode, could be either {@link FlushMode.SYNC} or {@link FlushMode.ASYNC}. * @@ -2974,7 +2950,7 @@ export class BaseTransaction> { /** * Deletes all the keys of the currently selected database. This command never fails. * - * See https://valkey.io/commands/flushdb/ for more details. + * @see {@link https://valkey.io/commands/flushdb/|valkey.io} for details. * * @param mode - The flushing mode, could be either {@link FlushMode.SYNC} or {@link FlushMode.ASYNC}. * @@ -2989,7 +2965,8 @@ export class BaseTransaction> { * match is found, `null` is returned. If the `count` option is specified, then the function returns * an `array` of indices of matching elements within the list. * - * See https://valkey.io/commands/lpos/ for more details. + * @see {@link https://valkey.io/commands/lpos/|valkey.io} for details. + * @remarks Since Valkey version 6.0.6. * * @param key - The name of the list. * @param element - The value to search for within the list. @@ -2997,8 +2974,6 @@ export class BaseTransaction> { * * Command Response - The index of `element`, or `null` if `element` is not in the list. If the `count` * option is specified, then the function returns an `array` of indices of matching elements within the list. - * - * since - Valkey version 6.0.6. */ public lpos(key: string, element: string, options?: LPosOptions): T { return this.addAndReturn(createLPos(key, element, options)); @@ -3007,7 +2982,7 @@ export class BaseTransaction> { /** * Returns the number of keys in the currently selected database. * - * See https://valkey.io/commands/dbsize/ for more details. + * @see {@link https://valkey.io/commands/dbsize/|valkey.io} for details. * * Command Response - The number of keys in the currently selected database. */ @@ -3019,7 +2994,7 @@ export class BaseTransaction> { * Counts the number of set bits (population counting) in the string stored at `key`. The `options` argument can * optionally be provided to count the number of bits in a specific string interval. * - * See https://valkey.io/commands/bitcount for more details. + * @see {@link https://valkey.io/commands/bitcount/|valkey.io} for more details. * * @param key - The key for the string to count the set bits of. * @param options - The offset options. @@ -3036,7 +3011,7 @@ export class BaseTransaction> { * Adds geospatial members with their positions to the specified sorted set stored at `key`. * If a member is already a part of the sorted set, its position is updated. * - * See https://valkey.io/commands/geoadd/ for more details. + * @see {@link https://valkey.io/commands/geoadd/|valkey.io} for details. * * @param key - The key of the sorted set. * @param membersToGeospatialData - A mapping of member names to their corresponding positions - see @@ -3061,9 +3036,8 @@ export class BaseTransaction> { * Returns the members of a sorted set populated with geospatial information using {@link geoadd}, * which are within the borders of the area specified by a given shape. * - * See https://valkey.io/commands/geosearch/ for more details. - * - * since - Valkey 6.2.0 and above. + * @see {@link https://valkey.io/commands/geosearch/|valkey.io} for details. + * @remarks Since Valkey version 6.2.0. * * @param key - The key of the sorted set. * @param searchFrom - The query's center point options, could be one of: @@ -3108,9 +3082,8 @@ export class BaseTransaction> { * * To get the result directly, see {@link geosearch}. * - * See https://valkey.io/commands/geosearchstore/ for more details. - * - * since - Valkey 6.2.0 and above. + * @see {@link https://valkey.io/commands/geosearchstore/|valkey.io} for details. + * @remarks Since Valkey version 6.2.0. * * @param destination - The key of the destination sorted set. * @param source - The key of the sorted set. @@ -3146,7 +3119,7 @@ export class BaseTransaction> { * Returns the positions (longitude, latitude) of all the specified `members` of the * geospatial index represented by the sorted set at `key`. * - * See https://valkey.io/commands/geopos for more details. + * @see {@link https://valkey.io/commands/geopos/|valkey.io} for more details. * * @param key - The key of the sorted set. * @param members - The members for which to get the positions. @@ -3163,7 +3136,8 @@ export class BaseTransaction> { * Pops a member-score pair from the first non-empty sorted set, with the given `keys` * being checked in the order they are provided. * - * See https://valkey.io/commands/zmpop/ for more details. + * @see {@link https://valkey.io/commands/zmpop/|valkey.io} for details. + * @remarks Since Valkey version 7.0.0. * * @param keys - The keys of the sorted sets. * @param modifier - The element pop criteria - either {@link ScoreFilter.MIN} or @@ -3173,8 +3147,6 @@ export class BaseTransaction> { * Command Response - A two-element `array` containing the key name of the set from which the * element was popped, and a member-score `Record` of the popped element. * If no member could be popped, returns `null`. - * - * since Valkey version 7.0.0. */ public zmpop(keys: string[], modifier: ScoreFilter, count?: number): T { return this.addAndReturn(createZMPop(keys, modifier, count)); @@ -3185,10 +3157,10 @@ export class BaseTransaction> { * checked in the order they are provided. Blocks the connection when there are no members * to pop from any of the given sorted sets. `BZMPOP` is the blocking variant of {@link zmpop}. * - * See https://valkey.io/commands/bzmpop/ for more details. + * @see {@link https://valkey.io/commands/bzmpop/|valkey.io} for details. + * @remarks `BZMPOP` is a client blocking command, see {@link https://github.com/valkey-io/valkey-glide/wiki/General-Concepts#blocking-commands | Valkey Glide Wiki} for more details and best practices. + * @remarks Since Valkey version 7.0.0. * - * @remarks `BZMPOP` is a client blocking command, see {@link https://github.com/valkey-io/valkey-glide/wiki/General-Concepts#blocking-commands | the wiki} - * for more details and best practices. * @param keys - The keys of the sorted sets. * @param modifier - The element pop criteria - either {@link ScoreFilter.MIN} or * {@link ScoreFilter.MAX} to pop the member with the lowest/highest score accordingly. @@ -3198,8 +3170,6 @@ export class BaseTransaction> { * Command Response - A two-element `array` containing the key name of the set from which the element * was popped, and a member-score `Record` of the popped element. * If no member could be popped, returns `null`. - * - * since Valkey version 7.0.0. */ public bzmpop( keys: string[], @@ -3215,7 +3185,7 @@ export class BaseTransaction> { * If `member` does not exist in the sorted set, it is added with `increment` as its score. * If `key` does not exist, a new sorted set is created with the specified member as its sole member. * - * See https://valkey.io/commands/zincrby/ for details. + * @see {@link https://valkey.io/commands/zincrby/|valkey.io} for details. * * @param key - The key of the sorted set. * @param increment - The score increment. @@ -3230,7 +3200,7 @@ export class BaseTransaction> { /** * Iterates incrementally over a sorted set. * - * See https://valkey.io/commands/zscan for more details. + * @see {@link https://valkey.io/commands/zscan/|valkey.io} for more details. * * @param key - The key of the sorted set. * @param cursor - The cursor that points to the next iteration of results. A value of `"0"` indicates the start of @@ -3250,7 +3220,7 @@ export class BaseTransaction> { /** * Returns the distance between `member1` and `member2` saved in the geospatial index stored at `key`. * - * See https://valkey.io/commands/geodist/ for more details. + * @see {@link https://valkey.io/commands/geodist/|valkey.io} for details. * * @param key - The key of the sorted set. * @param member1 - The name of the first member. @@ -3272,7 +3242,7 @@ export class BaseTransaction> { /** * Returns the `GeoHash` strings representing the positions of all the specified `members` in the sorted set stored at `key`. * - * See https://valkey.io/commands/geohash/ for more details. + * @see {@link https://valkey.io/commands/geohash/|valkey.io} for details. * * @param key - The key of the sorted set. * @param members - The array of members whose `GeoHash` strings are to be retrieved. @@ -3288,7 +3258,7 @@ export class BaseTransaction> { * Returns `UNIX TIME` of the last DB save timestamp or startup timestamp if no save * was made since then. * - * See https://valkey.io/commands/lastsave/ for more details. + * @see {@link https://valkey.io/commands/lastsave/|valkey.io} for details. * * Command Response - `UNIX TIME` of the last DB save executed with success. */ @@ -3299,9 +3269,8 @@ export class BaseTransaction> { /** * Returns all the longest common subsequences combined between strings stored at `key1` and `key2`. * - * since Valkey version 7.0.0. - * - * See https://valkey.io/commands/lcs/ for more details. + * @see {@link https://valkey.io/commands/lcs/|valkey.io} for details. + * @remarks Since Valkey version 7.0.0. * * @param key1 - The key that stores the first string. * @param key2 - The key that stores the second string. @@ -3316,9 +3285,8 @@ export class BaseTransaction> { /** * Returns the total length of all the longest common subsequences between strings stored at `key1` and `key2`. * - * since Valkey version 7.0.0. - * - * See https://valkey.io/commands/lcs/ for more details. + * @see {@link https://valkey.io/commands/lcs/|valkey.io} for details. + * @remarks Since Valkey version 7.0.0. * * @param key1 - The key that stores the first string. * @param key2 - The key that stores the second string. @@ -3333,9 +3301,8 @@ export class BaseTransaction> { * Returns the indices and lengths of the longest common subsequences between strings stored at * `key1` and `key2`. * - * since Valkey version 7.0.0. - * - * See https://valkey.io/commands/lcs/ for more details. + * @see {@link https://valkey.io/commands/lcs/|valkey.io} for details. + * @remarks Since Valkey version 7.0.0. * * @param key1 - The key that stores the first string. * @param key2 - The key that stores the second string. @@ -3362,7 +3329,7 @@ export class BaseTransaction> { /** * Updates the last access time of the specified keys. * - * See https://valkey.io/commands/touch/ for more details. + * @see {@link https://valkey.io/commands/touch/|valkey.io} for details. * * @param keys - The keys to update the last access time of. * @@ -3375,7 +3342,7 @@ export class BaseTransaction> { /** * Returns a random existing key name from the currently selected database. * - * See https://valkey.io/commands/randomkey/ for more details. + * @see {@link https://valkey.io/commands/randomkey/|valkey.io} for details. * * Command Response - A random existing key name from the currently selected database. */ @@ -3388,7 +3355,7 @@ export class BaseTransaction> { * for the entire length of `value`. If the `offset` is larger than the current length of the string at `key`, * the string is padded with zero bytes to make `offset` fit. Creates the `key` if it doesn't exist. * - * See https://valkey.io/commands/setrange/ for more details. + * @see {@link https://valkey.io/commands/setrange/|valkey.io} for details. * * @param key - The key of the string to update. * @param offset - The position in the string where `value` should be written. @@ -3404,7 +3371,7 @@ export class BaseTransaction> { * Appends a `value` to a `key`. If `key` does not exist it is created and set as an empty string, * so `APPEND` will be similar to {@link set} in this special case. * - * See https://valkey.io/commands/append/ for more details. + * @see {@link https://valkey.io/commands/append/|valkey.io} for details. * * @param key - The key of the string. * @param value - The key of the string. @@ -3418,16 +3385,14 @@ export class BaseTransaction> { /** * Pops one or more elements from the first non-empty list from the provided `keys`. * - * See https://valkey.io/commands/lmpop/ for more details. + * @see {@link https://valkey.io/commands/lmpop/|valkey.io} for details. + * @remarks Since Valkey version 7.0.0. * - * @remarks When in cluster mode, `source` and `destination` must map to the same hash slot. * @param keys - An array of keys to lists. * @param direction - The direction based on which elements are popped from - see {@link ListDirection}. * @param count - (Optional) The maximum number of popped elements. * * Command Response - A `Record` of `key` name mapped array of popped elements. - * - * since Valkey version 7.0.0. */ public lmpop(keys: string[], direction: ListDirection, count?: number): T { return this.addAndReturn(createLMPop(keys, direction, count)); @@ -3437,7 +3402,8 @@ export class BaseTransaction> { * Blocks the connection until it pops one or more elements from the first non-empty list from the * provided `key`. `BLMPOP` is the blocking variant of {@link lmpop}. * - * See https://valkey.io/commands/blmpop/ for more details. + * @see {@link https://valkey.io/commands/blmpop/|valkey.io} for details. + * @remarks Since Valkey version 7.0.0. * * @param keys - An array of keys to lists. * @param direction - The direction based on which elements are popped from - see {@link ListDirection}. @@ -3447,8 +3413,6 @@ export class BaseTransaction> { * * Command Response - A `Record` of `key` name mapped array of popped elements. * If no member could be popped and the timeout expired, returns `null`. - * - * since Valkey version 7.0.0. */ public blmpop( keys: string[], @@ -3463,7 +3427,7 @@ export class BaseTransaction> { * Lists the currently active channels. * The command is routed to all nodes, and aggregates the response to a single array. * - * See https://valkey.io/commands/pubsub-channels for more details. + * @see {@link https://valkey.io/commands/pubsub-channels/|valkey.io} for more details. * * @param pattern - A glob-style pattern to match active channels. * If not provided, all active channels are returned. @@ -3481,7 +3445,7 @@ export class BaseTransaction> { * not the count of clients subscribed to patterns. * The command is routed to all nodes, and aggregates the response to the sum of all pattern subscriptions. * - * See https://valkey.io/commands/pubsub-numpat for more details. + * @see {@link https://valkey.io/commands/pubsub-numpat/|valkey.io} for more details. * * Command Response - The number of unique patterns. */ @@ -3495,7 +3459,7 @@ export class BaseTransaction> { * Note that it is valid to call this command without channels. In this case, it will just return an empty map. * The command is routed to all nodes, and aggregates the response to a single map of the channels and their number of subscriptions. * - * See https://valkey.io/commands/pubsub-numsub for more details. + * @see {@link https://valkey.io/commands/pubsub-numsub/|valkey.io} for more details. * * @param channels - The list of channels to query for the number of subscribers. * If not provided, returns an empty map. @@ -3530,7 +3494,7 @@ export class Transaction extends BaseTransaction { /// TODO: add MOVE, SLAVEOF and all SENTINEL commands /** Change the currently selected Redis database. - * See https://valkey.io/commands/select/ for details. + * @see {@link https://valkey.io/commands/select/|valkey.io} for details. * * @param index - The index of the database to select. * @@ -3548,7 +3512,7 @@ export class Transaction extends BaseTransaction { * * To store the result into a new key, see {@link sortStore}. * - * See https://valkey.io/commands/sort for more details. + * @see {@link https://valkey.io/commands/sort/|valkey.io} for more details. * * @param key - The key of the list, set, or sorted set to be sorted. * @param options - (Optional) {@link SortOptions}. @@ -3567,7 +3531,7 @@ export class Transaction extends BaseTransaction { * * This command is routed depending on the client's {@link ReadFrom} strategy. * - * since Valkey version 7.0.0. + * @remarks Since Valkey version 7.0.0. * * @param key - The key of the list, set, or sorted set to be sorted. * @param options - (Optional) {@link SortOptions}. @@ -3587,9 +3551,8 @@ export class Transaction extends BaseTransaction { * * To get the sort result without storing it into a key, see {@link sort} or {@link sortReadOnly}. * - * See https://valkey.io/commands/sort for more details. + * @see {@link https://valkey.io/commands/sort/|valkey.io} for more details. * - * @remarks When in cluster mode, `destination` and `key` must map to the same hash slot. * @param key - The key of the list, set, or sorted set to be sorted. * @param destination - The key where the sorted result will be stored. * @param options - (Optional) {@link SortOptions}. @@ -3610,7 +3573,8 @@ export class Transaction extends BaseTransaction { * When `replace` is true, removes the `destination` key first if it already exists, otherwise performs * no action. * - * See https://valkey.io/commands/copy/ for more details. + * @see {@link https://valkey.io/commands/copy/|valkey.io} for details. + * @remarks Since Valkey version 6.2.0. * * @param source - The key to the source value. * @param destination - The key where the value should be copied to. @@ -3620,8 +3584,6 @@ export class Transaction extends BaseTransaction { * value to it. If not provided, no action will be performed if the key already exists. * * Command Response - `true` if `source` was copied, `false` if the `source` was not copied. - * - * since Valkey version 6.2.0. */ public copy( source: string, @@ -3634,7 +3596,7 @@ export class Transaction extends BaseTransaction { /** * Move `key` from the currently selected database to the database specified by `dbIndex`. * - * See https://valkey.io/commands/move/ for more details. + * @see {@link https://valkey.io/commands/move/|valkey.io} for details. * * @param key - The key to move. * @param dbIndex - The index of the database to move `key` to. @@ -3648,7 +3610,7 @@ export class Transaction extends BaseTransaction { /** Publish a message on pubsub channel. * - * See https://valkey.io/commands/publish for more details. + * @see {@link https://valkey.io/commands/publish/|valkey.io} for more details. * * @param message - Message to publish. * @param channel - Channel to publish the message on. @@ -3683,7 +3645,7 @@ export class ClusterTransaction extends BaseTransaction { * * To store the result into a new key, see {@link sortStore}. * - * See https://valkey.io/commands/sort for more details. + * @see {@link https://valkey.io/commands/sort/|valkey.io} for more details. * * @param key - The key of the list, set, or sorted set to be sorted. * @param options - (Optional) {@link SortClusterOptions}. @@ -3702,7 +3664,8 @@ export class ClusterTransaction extends BaseTransaction { * * This command is routed depending on the client's {@link ReadFrom} strategy. * - * since Valkey version 7.0.0. + * @see {@link https://valkey.io/commands/sort/|valkey.io} for more details. + * @remarks Since Valkey version 7.0.0. * * @param key - The key of the list, set, or sorted set to be sorted. * @param options - (Optional) {@link SortClusterOptions}. @@ -3725,9 +3688,8 @@ export class ClusterTransaction extends BaseTransaction { * * To get the sort result without storing it into a key, see {@link sort} or {@link sortReadOnly}. * - * See https://valkey.io/commands/sort for more details. + * @see {@link https://valkey.io/commands/sort|valkey.io} for more details. * - * @remarks When in cluster mode, `destination` and `key` must map to the same hash slot. * @param key - The key of the list, set, or sorted set to be sorted. * @param destination - The key where the sorted result will be stored. * @param options - (Optional) {@link SortClusterOptions}. @@ -3746,7 +3708,8 @@ export class ClusterTransaction extends BaseTransaction { * Copies the value stored at the `source` to the `destination` key. When `replace` is true, * removes the `destination` key first if it already exists, otherwise performs no action. * - * See https://valkey.io/commands/copy/ for more details. + * @see {@link https://valkey.io/commands/copy/|valkey.io} for details. + * @remarks Since Valkey version 6.2.0. * * @param source - The key to the source value. * @param destination - The key where the value should be copied to. @@ -3754,8 +3717,6 @@ export class ClusterTransaction extends BaseTransaction { * value to it. If not provided, no action will be performed if the key already exists. * * Command Response - `true` if `source` was copied, `false` if the `source` was not copied. - * - * since Valkey version 6.2.0. */ public copy( source: string, @@ -3772,7 +3733,7 @@ export class ClusterTransaction extends BaseTransaction { * The mode is selected using the 'sharded' parameter. * For both sharded and non-sharded mode, request is routed using hashed channel as key. * - * See https://valkey.io/commands/publish and https://valkey.io/commands/spublish for more details. + * @see {@link https://valkey.io/commands/publish} and {@link https://valkey.io/commands/spublish} for more details. * * @param message - Message to publish. * @param channel - Channel to publish the message on. @@ -3792,7 +3753,7 @@ export class ClusterTransaction extends BaseTransaction { * Lists the currently active shard channels. * The command is routed to all nodes, and aggregates the response to a single array. * - * See https://valkey.io/commands/pubsub-shardchannels for more details. + * @see {@link https://valkey.io/commands/pubsub-shardchannels|valkey.io} for more details. * * @param pattern - A glob-style pattern to match active shard channels. * If not provided, all active shard channels are returned. @@ -3809,7 +3770,7 @@ export class ClusterTransaction extends BaseTransaction { * Note that it is valid to call this command without channels. In this case, it will just return an empty map. * The command is routed to all nodes, and aggregates the response to a single map of the channels and their number of subscriptions. * - * See https://valkey.io/commands/pubsub-shardnumsub for more details. + * @see {@link https://valkey.io/commands/pubsub-shardnumsub|valkey.io} for more details. * * @param channels - The list of shard channels to query for the number of subscribers. * If not provided, returns an empty map.