Skip to content

Commit

Permalink
Addressed review comment
Browse files Browse the repository at this point in the history
Signed-off-by: Yi-Pin Chen <yi-pin.chen@improving.com>
  • Loading branch information
yipin-chen committed Aug 15, 2024
1 parent d3753a3 commit a581cb2
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
10 changes: 5 additions & 5 deletions node/src/BaseClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
8 changes: 4 additions & 4 deletions node/src/Commands.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;
};
Expand Down

0 comments on commit a581cb2

Please sign in to comment.