Skip to content

Commit

Permalink
Update see and since for new commands
Browse files Browse the repository at this point in the history
Signed-off-by: Andrew Carbonetto <[email protected]>
  • Loading branch information
acarbonetto committed Aug 14, 2024
1 parent 330af0b commit baacf9f
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 16 deletions.
21 changes: 9 additions & 12 deletions node/src/BaseClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ import {
StreamPendingOptions,
StreamReadOptions,
StreamTrimOptions,
TimeUnit,
ZAddOptions,
createAppend,
createBLMPop,
Expand Down Expand Up @@ -205,7 +206,6 @@ import {
createZRevRankWithScore,
createZScan,
createZScore,
TimeUnit,
} from "./Commands";
import {
ClosingError,
Expand Down Expand Up @@ -939,16 +939,15 @@ 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.
* "persist" will retain the time to live associated with the key. Equivalent to `PERSIST` in the VALKEY API.
* Otherwise, a {@link TimeUnit} and duration of the expire time should be specified.
* @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 }});
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion node/src/GlideClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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".
Expand Down
6 changes: 3 additions & 3 deletions node/src/GlideClusterClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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();
Expand Down

0 comments on commit baacf9f

Please sign in to comment.