From fe6873daed6d3c61c8593b4e62a58a41646150ba Mon Sep 17 00:00:00 2001 From: Andrew Carbonetto Date: Mon, 12 Aug 2024 14:58:48 -0700 Subject: [PATCH] Use @see tag; use @remarks for since Version doc labels Signed-off-by: Andrew Carbonetto --- node/src/BaseClient.ts | 552 ++++++++++++++++++--------------- node/src/GlideClient.ts | 101 +++--- node/src/GlideClusterClient.ts | 108 +++---- node/src/Transaction.ts | 508 ++++++++++++++---------------- 4 files changed, 627 insertions(+), 642 deletions(-) diff --git a/node/src/BaseClient.ts b/node/src/BaseClient.ts index 6732d8b70a..35b41c6f46 100644 --- a/node/src/BaseClient.ts +++ b/node/src/BaseClient.ts @@ -828,7 +828,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. * @returns If `key` exists, returns the value of `key` as a string. Otherwise, return null. @@ -847,7 +848,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. * @returns If `key` exists, returns the `value` of `key`. Otherwise, return `null`. @@ -871,7 +872,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. @@ -900,7 +901,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. @@ -937,7 +939,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. @@ -962,7 +965,8 @@ 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. @@ -983,7 +987,8 @@ 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. @@ -1004,9 +1009,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. * @@ -1024,7 +1029,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. @@ -1042,7 +1048,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. @@ -1063,7 +1070,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. @@ -1082,7 +1090,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. @@ -1100,7 +1109,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. @@ -1122,7 +1132,7 @@ 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. @@ -1155,7 +1165,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. @@ -1178,7 +1188,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. @@ -1201,7 +1211,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`. @@ -1238,7 +1248,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`. @@ -1276,7 +1286,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 @@ -1313,9 +1323,9 @@ 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. * - * Since Valkey version 6.0.0. + * @remarks Since Valkey version 6.0.0. * * @param key - The key of the string. * @param subcommands - The {@link BitFieldGet} subcommands to be performed. @@ -1336,7 +1346,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. @@ -1362,7 +1373,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 @@ -1386,7 +1398,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. @@ -1413,7 +1426,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`. @@ -1432,7 +1446,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. @@ -1452,7 +1467,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`. @@ -1477,7 +1493,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. @@ -1497,7 +1514,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. @@ -1522,7 +1540,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. @@ -1545,7 +1564,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. @@ -1569,7 +1589,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. @@ -1588,7 +1609,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. @@ -1608,9 +1629,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 @@ -1628,9 +1648,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. @@ -1655,9 +1674,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. @@ -1683,7 +1701,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`. @@ -1711,7 +1730,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`. @@ -1728,7 +1747,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. @@ -1753,7 +1773,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. @@ -1782,7 +1803,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. @@ -1818,7 +1840,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`. @@ -1840,9 +1863,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. - * - * Since Valkey version 6.2.0. + * @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. @@ -1882,13 +1904,11 @@ export class BaseClient { * of the list stored at `destination` depending on `whereTo`. * `BLMOVE` is the blocking variant of {@link lmove}. * + * @see {@link https://valkey.io/commands/blmove/|valkey.io} for details. * @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. - * - * Since Valkey version 6.2.0. + * @remarks Since Valkey version 6.2.0. * * @param source - The key to the source list. * @param destination - The key to the destination list. @@ -1929,7 +1949,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. @@ -1951,7 +1971,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. @@ -1997,7 +2018,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`. @@ -2025,7 +2047,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`. @@ -2042,7 +2064,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. @@ -2067,7 +2090,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. @@ -2094,7 +2118,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`. @@ -2112,7 +2137,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`. @@ -2131,7 +2157,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. @@ -2152,8 +2179,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. @@ -2178,7 +2205,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. @@ -2195,9 +2223,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. @@ -2225,11 +2254,10 @@ export class BaseClient { /** * Gets the cardinality of the intersection of all the given sets. * - * See https://valkey.io/commands/sintercard/ for more details. - * - * Since Valkey version 7.0.0. - * + * @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. @@ -2252,9 +2280,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. @@ -2272,9 +2300,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. @@ -2296,9 +2324,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. @@ -2318,9 +2346,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. @@ -2346,9 +2374,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. @@ -2364,7 +2392,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. @@ -2392,9 +2421,8 @@ 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. - * - * Since Valkey version 6.2.0. + * @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. @@ -2412,8 +2440,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. @@ -2438,7 +2467,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. @@ -2468,7 +2498,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. @@ -2494,7 +2524,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. @@ -2524,7 +2554,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, @@ -2544,7 +2575,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. @@ -2564,7 +2596,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. @@ -2598,7 +2631,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. @@ -2627,9 +2661,8 @@ 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. - * - * Since Valkey version 7.0.0. + * @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. @@ -2656,7 +2689,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. @@ -2685,7 +2719,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. @@ -2713,9 +2748,8 @@ 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. - * - * Since Valkey version 7.0.0. + * @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. @@ -2739,7 +2773,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. @@ -2773,7 +2808,8 @@ export class BaseClient { * This method simplifies the process of invoking scripts on a Redis 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. + * + * @see {@link https://valkey.io/commands/script-load/} and {@link https://valkey.io/commands/evalsha/} for details. * * @param script - The Lua script to execute. * @param options - The script option that contains keys and arguments for the script. @@ -2820,7 +2856,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. @@ -2856,7 +2893,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. @@ -2892,7 +2930,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. @@ -2918,7 +2957,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. @@ -2945,11 +2985,10 @@ 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. - * - * Since Valkey version 7.0.0. - * + * @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. @@ -2969,11 +3008,10 @@ 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. - * - * Since Valkey version 6.2.0. - * + * @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`. @@ -2995,11 +3033,10 @@ 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. - * - * Since Valkey version 6.2.0. - * + * @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`. @@ -3022,11 +3059,10 @@ 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. - * - * Since Valkey version 6.2.0. - * + * @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`. @@ -3047,7 +3083,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. @@ -3083,9 +3120,8 @@ 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. - * - * Since Valkey version 6.2.0. + * @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. @@ -3103,7 +3139,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. @@ -3137,8 +3174,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. @@ -3177,7 +3215,7 @@ 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. @@ -3224,11 +3262,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. - * - * Since Valkey version 6.2.0. - * + * @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. @@ -3271,9 +3308,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: @@ -3306,7 +3342,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. @@ -3331,7 +3367,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. @@ -3362,7 +3398,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. @@ -3392,7 +3428,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 @@ -3418,7 +3455,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. @@ -3446,7 +3484,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. @@ -3481,9 +3520,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. @@ -3506,7 +3545,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. @@ -3541,9 +3581,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. @@ -3564,7 +3604,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. @@ -3597,7 +3638,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. @@ -3625,7 +3667,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. @@ -3659,7 +3701,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. @@ -3695,7 +3738,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. @@ -3725,8 +3768,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. @@ -3753,9 +3797,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 lowest to highest. * - * See https://valkey.io/commands/zrank for more details. - * - * Since Valkey version 7.2.0. + * @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. @@ -3788,7 +3831,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. @@ -3809,9 +3852,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. - * - * Since Valkey version 7.2.0. + * @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. @@ -3834,7 +3876,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. @@ -3852,7 +3895,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. @@ -3871,7 +3914,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. @@ -3883,7 +3927,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. @@ -3914,7 +3959,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`. @@ -3932,7 +3977,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. @@ -3961,7 +4006,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. @@ -4004,7 +4049,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. @@ -4036,7 +4081,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. @@ -4073,7 +4118,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. @@ -4106,7 +4151,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. @@ -4134,7 +4179,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. @@ -4156,12 +4201,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"); @@ -4226,7 +4274,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. @@ -4252,7 +4300,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. @@ -4287,7 +4335,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. @@ -4315,7 +4364,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 @@ -4345,7 +4394,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. @@ -4364,7 +4414,8 @@ 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. @@ -4385,7 +4436,8 @@ 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. @@ -4409,11 +4461,12 @@ 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. * + * @see {@link https://valkey.io/commands/brpop/|valkey.io} 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. + * * @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, @@ -4437,11 +4490,12 @@ 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. * + * @see {@link https://valkey.io/commands/blpop/|valkey.io} 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. + * * @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, @@ -4464,7 +4518,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`. @@ -4485,9 +4539,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`. @@ -4505,9 +4559,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. @@ -4531,7 +4585,7 @@ export class BaseClient { /** 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. * @returns - If `key` exists, returns the internal encoding of the object stored at `key` as a string. @@ -4548,7 +4602,7 @@ export class BaseClient { /** 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. * @returns - If `key` exists, returns the logarithmic access frequency counter of the object @@ -4566,7 +4620,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`. @@ -4584,7 +4638,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`. @@ -4603,11 +4657,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`. @@ -4631,11 +4684,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`. @@ -4662,9 +4714,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. - * - * Since Valkey version 6.0.6. + * @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. @@ -4691,7 +4742,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. @@ -4715,7 +4766,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 @@ -4749,9 +4800,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 version 6.2.0. + * @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: @@ -4831,11 +4881,9 @@ export class BaseClient { * * To get the result directly, see {@link geosearch}. * - * See https://valkey.io/commands/geosearchstore/ for more details. - * - * Since Valkey version 6.2.0. - * + * @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. @@ -4906,7 +4954,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. @@ -4935,11 +4983,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. - * - * Since Valkey version 7.0.0. - * + * @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. @@ -4969,14 +5016,13 @@ 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. - * - * Since Valkey version 7.0.0. - * + * @see {@link https://valkey.io/commands/bzmpop/|valkey.io} for more details. * @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. + * @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. @@ -5011,7 +5057,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. @@ -5042,7 +5088,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 @@ -5089,7 +5135,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. @@ -5118,7 +5164,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. @@ -5142,11 +5188,9 @@ export class BaseClient { /** * Returns all the longest common subsequences combined between strings stored at `key1` and `key2`. * - * See https://valkey.io/commands/lcs/ for more details. - * - * 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. + * @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. @@ -5167,11 +5211,9 @@ export class BaseClient { /** * Returns the total length of all the longest common subsequences between strings stored at `key1` and `key2`. * - * See https://valkey.io/commands/lcs/ for more details. - * - * 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. + * @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. @@ -5192,11 +5234,9 @@ export class BaseClient { * Returns the indices and lengths of the longest common subsequences between strings stored at * `key1` and `key2`. * - * See https://valkey.io/commands/lcs/ for more details. - * - * 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. + * @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. @@ -5247,9 +5287,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. * @@ -5270,9 +5310,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. * @@ -5302,7 +5342,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. @@ -5329,7 +5369,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. @@ -5354,11 +5394,10 @@ 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. - * - * Since Valkey version 7.0.0. - * + * @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. @@ -5384,11 +5423,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. - * - * Since Valkey version 7.0.0. - * + * @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. @@ -5419,7 +5457,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. @@ -5446,7 +5484,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. * @@ -5466,7 +5504,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 e153f44b82..8562f6f878 100644 --- a/node/src/GlideClient.ts +++ b/node/src/GlideClient.ts @@ -55,7 +55,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 { /** @@ -128,8 +128,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 + * For full documentation, + * @see {@link https://github.com/valkey-io/valkey-glide/wiki/NodeJS-wrapper#standalone|Valkey Glide Wiki} */ export class GlideClient extends BaseClient { /** @@ -166,8 +166,9 @@ 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. * @returns A list of results corresponding to the execution of each command in the transaction. @@ -189,8 +190,7 @@ export class GlideClient extends BaseClient { /** 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. * * @example * ```typescript @@ -204,7 +204,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". @@ -230,7 +230,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. @@ -241,7 +241,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. @@ -258,7 +258,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. * @@ -274,7 +274,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. * @@ -290,7 +290,7 @@ 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". * @@ -306,7 +306,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. */ @@ -315,7 +315,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. * @@ -332,11 +333,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 @@ -351,7 +352,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`. @@ -368,7 +369,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. @@ -391,9 +392,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. - * - * Since Valkey version 6.2.0. + * @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. @@ -430,7 +430,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. @@ -450,7 +450,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. @@ -468,9 +468,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. @@ -488,9 +487,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 @@ -516,9 +514,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. @@ -536,9 +533,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. @@ -572,15 +568,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 @@ -623,7 +617,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`. @@ -641,7 +635,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`. @@ -659,7 +653,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. * @@ -675,7 +669,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. @@ -701,7 +695,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}. @@ -731,7 +725,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}. @@ -762,9 +757,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}. @@ -792,7 +787,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 @@ -808,7 +803,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. * @@ -826,7 +821,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 7827734f17..fc6e3268aa 100644 --- a/node/src/GlideClusterClient.ts +++ b/node/src/GlideClusterClient.ts @@ -85,7 +85,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 { /** @@ -282,8 +282,7 @@ 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 {@link https://github.com/valkey-io/valkey-glide/wiki/NodeJS-wrapper#cluster|Valkey Glide Wiki} for full documentation. */ export class GlideClusterClient extends BaseClient { /** @@ -341,8 +340,7 @@ export class GlideClusterClient extends BaseClient { * The command will be routed automatically based on the passed command's default request policy, unless `route` is provided, * in which case the client will route the command to the nodes defined by `route`. * - * 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 @@ -356,8 +354,9 @@ export class GlideClusterClient extends BaseClient { return super.createWritePromise(command, toProtobufRoute(route)); } - /** 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. @@ -384,7 +383,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". @@ -415,7 +415,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. @@ -435,7 +435,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`. @@ -468,11 +468,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 @@ -490,11 +489,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 @@ -512,7 +510,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`. @@ -527,7 +525,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 @@ -562,13 +560,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 @@ -589,7 +586,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 @@ -621,7 +618,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`. @@ -654,9 +651,8 @@ 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. - * - * Since Valkey version 6.2.0. + * @see {@link https://valkey.io/commands/copy/|valkey.io} for details. + * @remarks Since Valkey version 6.2.0. * * @remarks When in cluster mode, `source` and `destination` must map to the same hash slot. * @param source - The key to the source value. @@ -684,7 +680,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 @@ -710,9 +706,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. @@ -740,9 +735,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. @@ -771,9 +765,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 @@ -799,9 +792,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 @@ -831,9 +823,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 @@ -856,9 +847,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`. @@ -898,17 +888,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 @@ -956,7 +944,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 @@ -979,7 +967,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 @@ -1002,7 +990,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`. @@ -1024,7 +1012,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. @@ -1059,7 +1047,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. @@ -1085,7 +1073,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. @@ -1114,7 +1102,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}. @@ -1142,7 +1130,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}. @@ -1171,9 +1159,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}. @@ -1199,7 +1187,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`. @@ -1220,7 +1208,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`. @@ -1243,7 +1231,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 ce3a989b9f..9b20155905 100644 --- a/node/src/Transaction.ts +++ b/node/src/Transaction.ts @@ -289,7 +289,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. * @@ -302,7 +302,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. * @@ -319,7 +319,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. @@ -332,7 +332,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. @@ -347,7 +347,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". @@ -360,7 +360,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. @@ -372,7 +372,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. * @@ -383,7 +383,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. */ @@ -392,7 +392,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. */ @@ -401,7 +401,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". */ @@ -410,7 +410,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. * @@ -422,7 +422,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. * @@ -436,7 +436,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. @@ -446,7 +446,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. * @@ -457,7 +457,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. @@ -471,7 +471,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. @@ -484,7 +484,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. */ @@ -493,7 +493,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. * @@ -504,7 +504,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. @@ -519,7 +519,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. @@ -539,7 +539,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. @@ -557,7 +557,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. @@ -575,7 +575,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`. @@ -599,7 +599,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`. @@ -626,7 +626,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 @@ -653,9 +653,8 @@ 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. - * - * Since Valkey version 6.0.0. + * @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. @@ -668,7 +667,7 @@ export class BaseTransaction> { } /** 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. * @@ -680,7 +679,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. * @@ -691,7 +690,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. @@ -703,7 +702,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 @@ -718,7 +717,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. @@ -732,7 +731,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`. @@ -745,7 +744,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. @@ -759,7 +758,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`. @@ -772,7 +771,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. * @@ -786,7 +785,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. @@ -801,7 +800,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. @@ -814,7 +813,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. * @@ -825,7 +824,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. * @@ -838,7 +837,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. @@ -852,9 +851,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. * @@ -868,9 +866,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. @@ -888,9 +885,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. @@ -908,7 +904,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`. @@ -923,7 +919,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`. @@ -936,7 +932,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. * @@ -948,7 +944,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. @@ -964,7 +960,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. @@ -980,7 +976,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. * @@ -996,9 +992,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. - * - * Since Valkey version 6.2.0. + * @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. @@ -1025,9 +1020,8 @@ export class BaseTransaction> { * of the list stored at `destination` depending on `whereTo`. * `BLMOVE` is the blocking variant of {@link lmove}. * - * See https://valkey.io/commands/blmove/ for details. - * - * Since Valkey version 6.2.0. + * @see {@link https://valkey.io/commands/blmove/|valkey.io} for details. + * @remarks Since Valkey version 6.2.0. * * @remarks * 1. When in cluster mode, both `source` and `destination` must map to the same hash slot. @@ -1059,7 +1053,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. @@ -1075,7 +1069,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. @@ -1109,7 +1103,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`. @@ -1124,7 +1118,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`. @@ -1137,7 +1131,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. * @@ -1149,7 +1143,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. @@ -1163,7 +1157,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`. @@ -1175,7 +1169,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`. @@ -1188,7 +1182,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. * @@ -1201,7 +1195,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. @@ -1214,7 +1208,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. * @@ -1226,7 +1220,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. * @@ -1240,9 +1234,8 @@ export class BaseTransaction> { /** * Gets the cardinality of the intersection of all the given sets. * - * See https://valkey.io/commands/sintercard/ for more details. - * - * Since Valkey version 7.0.0. + * @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. * @@ -1255,7 +1248,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. @@ -1269,7 +1262,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. * @@ -1283,7 +1276,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. @@ -1297,7 +1290,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. * @@ -1312,7 +1305,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. @@ -1324,7 +1317,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. @@ -1339,9 +1332,8 @@ 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. - * - * Since Valkey version 6.2.0. + * @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. @@ -1353,7 +1345,7 @@ export class BaseTransaction> { } /** 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. @@ -1366,7 +1358,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. @@ -1380,7 +1372,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. @@ -1391,7 +1383,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. @@ -1404,7 +1396,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. * @@ -1418,7 +1410,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. * @@ -1432,7 +1424,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. @@ -1449,7 +1441,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. @@ -1470,9 +1462,8 @@ 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. - * - * Since Valkey version 7.0.0. + * @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. * @@ -1486,7 +1477,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. @@ -1507,7 +1498,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. @@ -1529,9 +1520,8 @@ 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. - * - * Since Valkey version 7.0.0. + * @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. * @@ -1542,7 +1532,7 @@ export class BaseTransaction> { } /** 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. * @@ -1554,7 +1544,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. @@ -1574,7 +1564,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. @@ -1597,7 +1587,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. @@ -1610,7 +1600,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. * @@ -1624,9 +1614,8 @@ 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. - * - * Since Valkey version 7.0.0. + * @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 @@ -1642,9 +1631,8 @@ 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. - * - * Since Valkey version 6.2.0. + * @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. * @@ -1659,9 +1647,8 @@ 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. - * - * Since Valkey version 6.2.0. + * @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. * @@ -1677,9 +1664,8 @@ 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. - * - * Since Valkey version 6.2.0. + * @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. @@ -1691,7 +1677,7 @@ export class BaseTransaction> { } /** 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. @@ -1707,9 +1693,8 @@ 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. - * - * Since Valkey version 6.2.0. + * @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. @@ -1722,7 +1707,7 @@ export class BaseTransaction> { } /** 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. @@ -1743,7 +1728,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. @@ -1766,7 +1751,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. @@ -1793,9 +1778,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. - * - * Since Valkey version 6.2.0. + * @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. @@ -1824,7 +1808,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: @@ -1846,7 +1830,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. @@ -1859,7 +1843,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. @@ -1875,7 +1859,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. @@ -1890,7 +1874,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. * @@ -1901,7 +1885,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. * @@ -1915,7 +1899,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. @@ -1934,7 +1918,7 @@ 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 @@ -1950,7 +1934,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. @@ -1969,7 +1953,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 @@ -1983,7 +1967,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. * @@ -1994,7 +1978,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. * @@ -2007,7 +1991,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. @@ -2025,7 +2009,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. @@ -2044,7 +2028,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. @@ -2067,7 +2051,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. @@ -2086,7 +2070,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. @@ -2101,9 +2085,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 lowest to highest. * - * See https://valkey.io/commands/zrank for more details. - * - * Since Valkey version 7.2.0. + * @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. @@ -2120,7 +2103,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. @@ -2136,9 +2119,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. - * - * Since Valkey version 7.2.0. + * @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. @@ -2153,7 +2135,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. * @@ -2179,7 +2161,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. @@ -2193,7 +2175,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 @@ -2216,7 +2198,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. @@ -2235,7 +2217,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. @@ -2249,7 +2231,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. @@ -2276,7 +2258,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. @@ -2288,7 +2270,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. @@ -2305,7 +2287,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. * @@ -2318,11 +2300,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. @@ -2337,7 +2319,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. @@ -2358,7 +2340,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`. @@ -2370,7 +2352,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. @@ -2398,7 +2380,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. @@ -2426,7 +2408,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. @@ -2449,7 +2431,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. @@ -2463,7 +2445,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. @@ -2484,7 +2466,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. @@ -2507,7 +2489,7 @@ 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. @@ -2521,7 +2503,7 @@ 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. @@ -2536,7 +2518,7 @@ 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. + * @see {@link https://valkey.io/commands/brpop/|valkey.io} for 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. * @@ -2553,7 +2535,7 @@ 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. + * @see {@link https://valkey.io/commands/blpop/|valkey.io} for 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. * @@ -2570,7 +2552,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`. @@ -2584,7 +2566,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. @@ -2598,7 +2580,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. @@ -2610,7 +2592,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. @@ -2622,7 +2604,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 @@ -2635,7 +2617,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. * @@ -2648,7 +2630,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. * @@ -2662,7 +2644,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. * @@ -2675,9 +2657,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, @@ -2693,9 +2674,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, @@ -2711,9 +2691,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. * @@ -2726,9 +2705,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 @@ -2743,9 +2721,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`. @@ -2757,9 +2734,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. * @@ -2773,9 +2749,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: * @@ -2789,7 +2764,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}. * @@ -2802,7 +2777,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}. * @@ -2817,9 +2792,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. - * - * Since Valkey version 6.0.6. + * @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. @@ -2835,7 +2809,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. */ @@ -2847,7 +2821,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. @@ -2864,7 +2838,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 @@ -2889,9 +2863,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 version 6.2.0. + * @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: @@ -2936,9 +2909,8 @@ export class BaseTransaction> { * * To get the result directly, see {@link geosearch}. * - * See https://valkey.io/commands/geosearchstore/ for more details. - * - * Since Valkey version 6.2.0. + * @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. @@ -2974,7 +2946,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. @@ -2991,9 +2963,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. - * - * Since Valkey version 7.0.0. + * @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 @@ -3013,9 +2984,8 @@ 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. - * - * Since Valkey version 7.0.0. + * @see {@link https://valkey.io/commands/bzmpop/|valkey.io} for details. + * @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. @@ -3043,7 +3013,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. @@ -3058,7 +3028,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 @@ -3078,7 +3048,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. @@ -3100,7 +3070,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. @@ -3116,7 +3086,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. */ @@ -3127,9 +3097,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. @@ -3144,9 +3113,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. @@ -3161,9 +3129,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. @@ -3190,7 +3157,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. * @@ -3203,7 +3170,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. */ @@ -3216,7 +3183,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. @@ -3232,7 +3199,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. @@ -3246,9 +3213,8 @@ 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. - * - * Since Valkey version 7.0.0. + * @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. @@ -3265,9 +3231,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. - * - * Since Valkey version 7.0.0. + * @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}. @@ -3291,7 +3256,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. @@ -3309,7 +3274,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. */ @@ -3323,7 +3288,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. @@ -3358,7 +3323,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. * @@ -3376,7 +3341,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}. @@ -3395,7 +3360,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}. @@ -3415,7 +3380,7 @@ 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. @@ -3438,9 +3403,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. - * - * Since Valkey version 6.2.0. + * @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. @@ -3462,7 +3426,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. @@ -3476,7 +3440,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. @@ -3511,7 +3475,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}. @@ -3530,7 +3494,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}. @@ -3553,7 +3518,7 @@ 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. @@ -3574,9 +3539,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. - * - * Since Valkey version 6.2.0. + * @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. @@ -3600,7 +3564,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. @@ -3620,7 +3584,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. @@ -3637,7 +3601,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.