From a581cb294858a6800ed1228c49489fdbfcd596f4 Mon Sep 17 00:00:00 2001 From: Yi-Pin Chen Date: Thu, 15 Aug 2024 16:13:18 -0700 Subject: [PATCH] Addressed review comment Signed-off-by: Yi-Pin Chen --- node/src/BaseClient.ts | 10 +++++----- node/src/Commands.ts | 8 ++++---- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/node/src/BaseClient.ts b/node/src/BaseClient.ts index cbd0ff327d..376f8cd287 100644 --- a/node/src/BaseClient.ts +++ b/node/src/BaseClient.ts @@ -1100,8 +1100,8 @@ export class BaseClient { * * @See {@link https://valkey.io/commands/dump/|valkey.io} for details. * - * @param key - The key of the set. - * @returns The serialized value of a set. If `key` does not exist, `null` will be returned. + * @param key - The `key` to serialize. + * @returns The serialized value of the data stored at `key`. If `key` does not exist, `null` will be returned. * * @example * ```typescript @@ -1127,11 +1127,11 @@ export class BaseClient { * * @See {@link https://valkey.io/commands/restore/|valkey.io} for details. * - * @param key - The key of the set. + * @param key - The `key` to create. * @param ttl - The expiry time (in milliseconds). If `0`, the `key` will persist. - * @param value - The serialized value. + * @param value - The serialized value to deserialize and assign to `key` * @param options - (Optional) Restore options {@link RestoreOptions}. - * @returns Return "OK" if successfully create a `key` with a `value`. + * @returns Return "OK" if the `key` was successfully restored with a `value`. * * @example * ```typescript diff --git a/node/src/Commands.ts b/node/src/Commands.ts index 343fc9d9c0..99921e53a9 100644 --- a/node/src/Commands.ts +++ b/node/src/Commands.ts @@ -2813,19 +2813,19 @@ export function createDump(key: GlideString): command_request.Command { /** Optional arguments for `RESTORE` command. */ export type RestoreOptions = { /** - * If set, existing key will be replaced. + * Set to `True` to replace the key if it exists. */ replace?: boolean; /** - * If set, the absolute timestamp (in milliseconds) for TTL will be used. + * Set to `True` to specify that `ttl` represents an absolute Unix timestamp (in milliseconds). */ absttl?: boolean; /** - * Set the object idletime. + * Set the `IDLETIME` option with object idletime to the given key. */ idletime?: number; /** - * Set the object frequency. + * Set the `FREQ` option with object frequency to the given key. */ frequency?: number; };