redis/node-redis
1
0
Fork 0
mirror of https://github.com/redis/node-redis.git synced 2025-08-04 15:02:09 +03:00
Code Activity

(docs) add jsdoc comments to command parsers (#2984)

Browse Source 
* (docs) bloom: add jsdocs for all commands

* (docs) json: add jsdocs

* (docs) search: add jsdocs for all commands

* (docs) jsdocs for std commands

* (docs) jsdoc comments to time series commands
This commit is contained in:
Bobby I.
2025-06-03 14:38:07 +03:00
committed by GitHub
parent e4a1ca467f
commit 20c16e0c2c
491 changed files with 3861 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
packages/client/lib/commands/RESTORE.ts
View File

@@ -1,6 +1,14 @@
import { CommandParser } from '../client/parser';
import { RedisArgument, SimpleStringReply, Command } from '../RESP/types';
/**
* Options for the RESTORE command
*
* @property REPLACE - Replace existing key
* @property ABSTTL - Use the TTL value as absolute timestamp
* @property IDLETIME - Set the idle time (seconds) for the key
* @property FREQ - Set the frequency counter for LFU policy
*/
export interface RestoreOptions {
REPLACE?: boolean;
ABSTTL?: boolean;
@@ -10,6 +18,16 @@ export interface RestoreOptions {
export default {
IS_READ_ONLY: false,
/**
* Constructs the RESTORE command
*
* @param parser - The command parser
* @param key - The key to restore
* @param ttl - Time to live in milliseconds, 0 for no expiry
* @param serializedValue - The serialized value from DUMP command
* @param options - Options for the RESTORE command
* @see https://redis.io/commands/restore/
*/
parseCommand(
parser: CommandParser,
key: RedisArgument,