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/CLIENT_PAUSE.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

21 lines
778 B
TypeScript

import { CommandParser } from '../client/parser';
import { SimpleStringReply, Command } from '../RESP/types';
export default {
NOT_KEYED_COMMAND: true,
IS_READ_ONLY: true,
/**
* Stops the server from processing client commands for the specified duration
* @param parser - The Redis command parser
* @param timeout - Time in milliseconds to pause command processing
* @param mode - Optional mode: 'WRITE' to pause only write commands, 'ALL' to pause all commands
*/
parseCommand(parser: CommandParser, timeout: number, mode?: 'WRITE' | 'ALL') {
parser.push('CLIENT', 'PAUSE', timeout.toString());
if (mode) {
parser.push(mode);
}
},
transformReply: undefined as unknown as () => SimpleStringReply<'OK'>
} as const satisfies Command;