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

28 lines
928 B
TypeScript

import { CommandParser } from '../client/parser';
import { RedisArgument, SimpleStringReply, Command } from '../RESP/types';
export interface AuthOptions {
username?: RedisArgument;
password: RedisArgument;
}
export default {
NOT_KEYED_COMMAND: true,
IS_READ_ONLY: true,
/**
* Authenticates the connection using a password or username and password
* @param parser - The Redis command parser
* @param options - Authentication options containing username and/or password
* @param options.username - Optional username for authentication
* @param options.password - Password for authentication
*/
parseCommand(parser: CommandParser, { username, password }: AuthOptions) {
parser.push('AUTH');
if (username !== undefined) {
parser.push(username);
}
parser.push(password);
},
transformReply: undefined as unknown as () => SimpleStringReply<'OK'>
} as const satisfies Command;