redis/node-redis
1
0
Fork 0
mirror of https://github.com/redis/node-redis.git synced 2025-08-06 02:15:48 +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

7
packages/client/lib/commands/AUTH.ts
View File

@@ -9,6 +9,13 @@ export interface AuthOptions {
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) {