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/CLUSTER_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

32 lines
892 B
TypeScript

import { CommandParser } from '../client/parser';
import { SimpleStringReply, Command } from '../RESP/types';
export const FAILOVER_MODES = {
FORCE: 'FORCE',
TAKEOVER: 'TAKEOVER'
} as const;
export type FailoverMode = typeof FAILOVER_MODES[keyof typeof FAILOVER_MODES];
export interface ClusterFailoverOptions {
mode?: FailoverMode;
}
export default {
NOT_KEYED_COMMAND: true,
IS_READ_ONLY: true,
/**
* Forces a replica to perform a manual failover of its master
* @param parser - The Redis command parser
* @param options - Optional configuration with FORCE or TAKEOVER mode
*/
parseCommand(parser:CommandParser, options?: ClusterFailoverOptions) {
parser.push('CLUSTER', 'FAILOVER');
if (options?.mode) {
parser.push(options.mode);
}
},
transformReply: undefined as unknown as () => SimpleStringReply<'OK'>
} as const satisfies Command;