1
0
mirror of https://github.com/redis/node-redis.git synced 2025-08-03 04:01:40 +03:00
Files
node-redis/packages/client/lib/commands/BITCOUNT.ts
Bobby I. 20c16e0c2c (docs) add jsdoc comments to command parsers (#2984)
* (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
2025-06-03 14:38:07 +03:00

36 lines
1.0 KiB
TypeScript

import { CommandParser } from '../client/parser';
import { RedisArgument, NumberReply, Command } from '../RESP/types';
export interface BitCountRange {
start: number;
end: number;
mode?: 'BYTE' | 'BIT';
}
export default {
CACHEABLE: true,
IS_READ_ONLY: true,
/**
* Returns the count of set bits in a string key
* @param parser - The Redis command parser
* @param key - The key to count bits in
* @param range - Optional range specification
* @param range.start - Start offset in bytes/bits
* @param range.end - End offset in bytes/bits
* @param range.mode - Optional counting mode: BYTE or BIT
*/
parseCommand(parser: CommandParser, key: RedisArgument, range?: BitCountRange) {
parser.push('BITCOUNT');
parser.pushKey(key);
if (range) {
parser.push(range.start.toString());
parser.push(range.end.toString());
if (range.mode) {
parser.push(range.mode);
}
}
},
transformReply: undefined as unknown as () => NumberReply
} as const satisfies Command;