1
0
mirror of https://github.com/redis/node-redis.git synced 2025-08-03 04:01:40 +03:00
Files
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

42 lines
1.1 KiB
TypeScript

import { CommandParser } from '../client/parser';
import { RedisArgument, NumberReply, Command } from '../RESP/types';
import { BitValue } from './generic-transformers';
export default {
CACHEABLE: true,
IS_READ_ONLY: true,
/**
* Returns the position of first bit set to 0 or 1 in a string
* @param parser - The Redis command parser
* @param key - The key holding the string
* @param bit - The bit value to look for (0 or 1)
* @param start - Optional starting position in bytes/bits
* @param end - Optional ending position in bytes/bits
* @param mode - Optional counting mode: BYTE or BIT
*/
parseCommand(parser: CommandParser,
key: RedisArgument,
bit: BitValue,
start?: number,
end?: number,
mode?: 'BYTE' | 'BIT'
) {
parser.push('BITPOS');
parser.pushKey(key);
parser.push(bit.toString());
if (start !== undefined) {
parser.push(start.toString());
}
if (end !== undefined) {
parser.push(end.toString());
}
if (mode) {
parser.push(mode);
}
},
transformReply: undefined as unknown as () => NumberReply
} as const satisfies Command;