From baacf9ffb9550a1aa2a04f7dd7b060232dd3f43f Mon Sep 17 00:00:00 2001 From: Andrew Carbonetto Date: Wed, 14 Aug 2024 15:00:24 -0700 Subject: [PATCH] Update see and since for new commands Signed-off-by: Andrew Carbonetto --- node/src/BaseClient.ts | 21 +++++++++------------ node/src/GlideClient.ts | 2 +- node/src/GlideClusterClient.ts | 6 +++--- 3 files changed, 13 insertions(+), 16 deletions(-) diff --git a/node/src/BaseClient.ts b/node/src/BaseClient.ts index 09064a8433..23016dd8ff 100644 --- a/node/src/BaseClient.ts +++ b/node/src/BaseClient.ts @@ -51,6 +51,7 @@ import { StreamPendingOptions, StreamReadOptions, StreamTrimOptions, + TimeUnit, ZAddOptions, createAppend, createBLMPop, @@ -205,7 +206,6 @@ import { createZRevRankWithScore, createZScan, createZScore, - TimeUnit, } from "./Commands"; import { ClosingError, @@ -939,7 +939,8 @@ export class BaseClient { /** * Get the value of `key` and optionally set its expiration. `GETEX` is similar to {@link get}. * - * See https://valkey.io/commands/getex for more details. + * @see {@link https://valkey.io/commands/getex/|valkey.op} for more details. + * @remarks Since Valkey version 6.2.0. * * @param key - The key to retrieve from the database. * @param options - (Optional) Set expiriation to the given key. @@ -947,8 +948,6 @@ export class BaseClient { * Otherwise, a {@link TimeUnit} and duration of the expire time should be specified. * @returns If `key` exists, returns the value of `key` as a `string`. Otherwise, return `null`. * - * since - Valkey 6.2.0 and above. - * * @example * ```typescript * const result = await client.getex("key", {expiry: { type: TimeUnit.Seconds, count: 5 }}); @@ -1764,7 +1763,7 @@ export class BaseClient { /** * Iterates incrementally over a hash. * - * See https://valkey.io/commands/hscan for more details. + * @see {@link https://valkey.io/commands//|valkey.io} for more details. * * @param key - The key of the set. * @param cursor - The cursor that points to the next iteration of results. A value of `"0"` indicates the start of the search. @@ -4277,9 +4276,8 @@ export class BaseClient { /** * Transfers ownership of pending stream entries that match the specified criteria. * - * See https://valkey.io/commands/xautoclaim/ for more details. - * - * since Valkey version 6.2.0. + * @see {@link https://valkey.io/commands/xautoclaim/|valkey.io} for more details. + * @remarks Since Valkey version 6.2.0. * * @param key - The key of the stream. * @param group - The consumer group name. @@ -4333,9 +4331,8 @@ export class BaseClient { /** * Transfers ownership of pending stream entries that match the specified criteria. * - * See https://valkey.io/commands/xautoclaim/ for more details. - * - * since Valkey version 6.2.0. + * @see {@link https://valkey.io/commands/xautoclaim/|valkey.io} for more details. + * @remarks Since Valkey version 6.2.0. * * @param key - The key of the stream. * @param group - The consumer group name. @@ -5616,7 +5613,7 @@ export class BaseClient { * acknowledged by at least `numreplicas` of replicas. If `timeout` is reached, the command returns * the number of replicas that were not yet reached. * - * See https://valkey.io/commands/wait/ for more details. + * @see {@link https://valkey.io/commands/wait/|valkey.io} for more details. * * @param numreplicas - The number of replicas to reach. * @param timeout - The timeout value specified in milliseconds. A value of 0 will block indefinitely. diff --git a/node/src/GlideClient.ts b/node/src/GlideClient.ts index 758f5bffd1..d133699a55 100644 --- a/node/src/GlideClient.ts +++ b/node/src/GlideClient.ts @@ -305,7 +305,7 @@ export class GlideClient extends BaseClient { } /** Resets the statistics reported by Redis using the INFO and LATENCY HISTOGRAM commands. - * + * * @see {@link https://valkey.io/commands/config-resetstat/|valkey.io} for details. * * @returns always "OK". diff --git a/node/src/GlideClusterClient.ts b/node/src/GlideClusterClient.ts index 2d3c2dcd07..4a1acc7c83 100644 --- a/node/src/GlideClusterClient.ts +++ b/node/src/GlideClusterClient.ts @@ -953,13 +953,13 @@ export class GlideClusterClient extends BaseClient { * Kills a function that is currently executing. * `FUNCTION KILL` terminates read-only functions only. * - * See https://valkey.io/commands/function-kill/ for details. - * - * since Valkey version 7.0.0. + * @see {@link https://valkey.io/commands/function-kill/|valkey.io} for details. + * @remarks Since Valkey version 7.0.0. * * @param route - (Optional) The client will route the command to the nodes defined by `route`. * If not defined, the command will be routed to all primary nodes. * @returns `OK` if function is terminated. Otherwise, throws an error. + * * @example * ```typescript * await client.functionKill();