You've already forked node-redis
mirror of
https://github.com/redis/node-redis.git
synced 2025-08-03 04:01:40 +03:00
* (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
60 lines
1.7 KiB
TypeScript
60 lines
1.7 KiB
TypeScript
import { CommandParser } from '../client/parser';
|
|
import { RedisArgument, Command } from '../RESP/types';
|
|
import { pushMembers } from './ZADD';
|
|
import { SortedSetMember, transformNullableDoubleReply } from './generic-transformers';
|
|
|
|
/**
|
|
* Options for the ZADD INCR command
|
|
*
|
|
* @property condition - Add condition: NX (only if not exists) or XX (only if exists)
|
|
* @property comparison - Score comparison: LT (less than) or GT (greater than)
|
|
* @property CH - Return the number of changed elements instead of added elements
|
|
*/
|
|
export interface ZAddOptions {
|
|
condition?: 'NX' | 'XX';
|
|
comparison?: 'LT' | 'GT';
|
|
CH?: boolean;
|
|
}
|
|
|
|
/**
|
|
* Command for incrementing the score of a member in a sorted set
|
|
*/
|
|
export default {
|
|
/**
|
|
* Constructs the ZADD command with INCR option to increment the score of a member
|
|
*
|
|
* @param parser - The command parser
|
|
* @param key - The sorted set key
|
|
* @param members - Member(s) whose score to increment
|
|
* @param options - Additional options for the increment operation
|
|
* @returns The new score of the member after increment (null if member does not exist with XX option)
|
|
* @see https://redis.io/commands/zadd/
|
|
*/
|
|
parseCommand(
|
|
parser: CommandParser,
|
|
key: RedisArgument,
|
|
members: SortedSetMember | Array<SortedSetMember>,
|
|
options?: ZAddOptions
|
|
) {
|
|
parser.push('ZADD');
|
|
parser.pushKey(key);
|
|
|
|
if (options?.condition) {
|
|
parser.push(options.condition);
|
|
}
|
|
|
|
if (options?.comparison) {
|
|
parser.push(options.comparison);
|
|
}
|
|
|
|
if (options?.CH) {
|
|
parser.push('CH');
|
|
}
|
|
|
|
parser.push('INCR');
|
|
|
|
pushMembers(parser, members);
|
|
},
|
|
transformReply: transformNullableDoubleReply
|
|
} as const satisfies Command;
|