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

41 lines
996 B
TypeScript

import { CommandParser } from '../client/parser';
import { SimpleStringReply, Command } from '../RESP/types';
interface FailoverOptions {
TO?: {
host: string;
port: number;
FORCE?: true;
};
ABORT?: true;
TIMEOUT?: number;
}
export default {
/**
* Starts a coordinated failover between the primary and a replica
* @param parser - The Redis command parser
* @param options - Failover options including target host, abort flag, and timeout
*/
parseCommand(parser: CommandParser, options?: FailoverOptions) {
parser.push('FAILOVER');
if (options?.TO) {
parser.push('TO', options.TO.host, options.TO.port.toString());
if (options.TO.FORCE) {
parser.push('FORCE');
}
}
if (options?.ABORT) {
parser.push('ABORT');
}
if (options?.TIMEOUT) {
parser.push('TIMEOUT', options.TIMEOUT.toString());
}
},
transformReply: undefined as unknown as () => SimpleStringReply
} as const satisfies Command;