redis/node-redis
1
0
Fork 0
mirror of https://github.com/redis/node-redis.git synced 2025-08-04 15:02:09 +03:00
Code Activity

(docs) add jsdoc comments to command parsers (#2984)

Browse Source 
* (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
This commit is contained in:
Bobby I.
2025-06-03 14:38:07 +03:00
committed by GitHub
parent e4a1ca467f
commit 20c16e0c2c
491 changed files with 3861 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
packages/client/lib/commands/SHUTDOWN.ts
View File

@@ -1,6 +1,14 @@
import { CommandParser } from '../client/parser';
import { SimpleStringReply, Command } from '../RESP/types';
/**
* Options for the SHUTDOWN command
*
* @property mode - NOSAVE will not save DB, SAVE will force save DB
* @property NOW - Immediately terminate all clients
* @property FORCE - Force shutdown even in case of errors
* @property ABORT - Abort a shutdown in progress
*/
export interface ShutdownOptions {
mode?: 'NOSAVE' | 'SAVE';
NOW?: boolean;
@@ -11,6 +19,13 @@ export interface ShutdownOptions {
export default {
NOT_KEYED_COMMAND: true,
IS_READ_ONLY: false,
/**
* Constructs the SHUTDOWN command
*
* @param parser - The command parser
* @param options - Options for the shutdown process
* @see https://redis.io/commands/shutdown/
*/
parseCommand(parser: CommandParser, options?: ShutdownOptions) {
parser.push('SHUTDOWN');