redis/node-redis
1
0
Fork 0
mirror of https://github.com/redis/node-redis.git synced 2025-08-06 02:15:48 +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

8
packages/client/lib/commands/HEXPIRE.ts
View File

@@ -16,6 +16,14 @@ export const HASH_EXPIRATION = {
export type HashExpiration = typeof HASH_EXPIRATION[keyof typeof HASH_EXPIRATION];
export default {
/**
* Sets a timeout on hash fields. After the timeout has expired, the fields will be automatically deleted
* @param parser - The Redis command parser
* @param key - Key of the hash
* @param fields - Fields to set expiration on
* @param seconds - Number of seconds until field expiration
* @param mode - Expiration mode: NX (only if field has no expiry), XX (only if field has existing expiry), GT (only if new expiry is greater than current), LT (only if new expiry is less than current)
*/
parseCommand(
parser: CommandParser,
key: RedisArgument,