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

25 lines
740 B
TypeScript

import { CommandParser } from '../client/parser';
import { SimpleStringReply, Command } from '../RESP/types';
export interface BgSaveOptions {
SCHEDULE?: boolean;
}
export default {
NOT_KEYED_COMMAND: true,
IS_READ_ONLY: true,
/**
* Asynchronously saves the dataset to disk
* @param parser - The Redis command parser
* @param options - Optional configuration
* @param options.SCHEDULE - Schedule a BGSAVE operation when no BGSAVE is already in progress
*/
parseCommand(parser: CommandParser, options?: BgSaveOptions) {
parser.push('BGSAVE');
if (options?.SCHEDULE) {
parser.push('SCHEDULE');
}
},
transformReply: undefined as unknown as () => SimpleStringReply
} as const satisfies Command;