(docs) jsdocs for std commands

Author: bobymicroby

packages/client/lib/commands/ACL_CAT.ts

@@ -4,6 +4,11 @@ import { RedisArgument, ArrayReply, BlobStringReply, Command } from '../RESP/typ
 export default {
   NOT_KEYED_COMMAND: true,
   IS_READ_ONLY: true,
+  /**
+   * Lists ACL categories or commands in a category
+   * @param parser - The Redis command parser
+   * @param categoryName - Optional category name to filter commands
+   */
   parseCommand(parser: CommandParser, categoryName?: RedisArgument) {
     parser.push('ACL', 'CAT');
     if (categoryName) {

packages/client/lib/commands/ACL_DELUSER.ts

@@ -5,6 +5,11 @@ import { RedisVariadicArgument } from './generic-transformers';
 export default {
   NOT_KEYED_COMMAND: true,
   IS_READ_ONLY: true,
+  /**
+   * Deletes one or more users from the ACL
+   * @param parser - The Redis command parser
+   * @param username - Username(s) to delete
+   */
   parseCommand(parser: CommandParser, username: RedisVariadicArgument) {
     parser.push('ACL', 'DELUSER');
     parser.pushVariadic(username);

packages/client/lib/commands/ACL_DRYRUN.ts

@@ -4,6 +4,12 @@ import { RedisArgument, SimpleStringReply, BlobStringReply, Command } from '../R
 export default {
   NOT_KEYED_COMMAND: true,
   IS_READ_ONLY: true,
+  /**
+   * Simulates ACL operations without executing them
+   * @param parser - The Redis command parser
+   * @param username - Username to simulate ACL operations for
+   * @param command - Command arguments to simulate
+   */
   parseCommand(parser: CommandParser, username: RedisArgument, command: Array<RedisArgument>) {
     parser.push('ACL', 'DRYRUN', username, ...command);
   },

packages/client/lib/commands/ACL_GENPASS.ts

@@ -4,6 +4,11 @@ import { BlobStringReply, Command } from '../RESP/types';
 export default {
   NOT_KEYED_COMMAND: true,
   IS_READ_ONLY: true,
+  /**
+   * Generates a secure password for ACL users
+   * @param parser - The Redis command parser
+   * @param bits - Optional number of bits for password entropy
+   */
   parseCommand(parser: CommandParser, bits?: number) {
     parser.push('ACL', 'GENPASS');
     if (bits) {

packages/client/lib/commands/ACL_GETUSER.ts

@@ -20,6 +20,11 @@ type AclUser = TuplesToMapReply<[
 export default {
   NOT_KEYED_COMMAND: true,
   IS_READ_ONLY: true,
+  /**
+   * Returns ACL information about a specific user
+   * @param parser - The Redis command parser
+   * @param username - Username to get information for
+   */
   parseCommand(parser: CommandParser, username: RedisArgument) {
     parser.push('ACL', 'GETUSER', username);
   },

packages/client/lib/commands/ACL_LIST.ts

@@ -4,6 +4,10 @@ import { ArrayReply, BlobStringReply, Command } from '../RESP/types';
 export default {
   NOT_KEYED_COMMAND: true,
   IS_READ_ONLY: true,
+  /**
+   * Returns all configured ACL users and their permissions
+   * @param parser - The Redis command parser
+   */
   parseCommand(parser: CommandParser) {
     parser.push('ACL', 'LIST');
   },

packages/client/lib/commands/ACL_LOAD.ts

@@ -4,6 +4,10 @@ import { SimpleStringReply, Command } from '../RESP/types';
 export default {
   NOT_KEYED_COMMAND: true,
   IS_READ_ONLY: true,
+  /**
+   * Reloads ACL configuration from the ACL file
+   * @param parser - The Redis command parser
+   */
   parseCommand(parser: CommandParser) {
     parser.push('ACL', 'LOAD');
   },

packages/client/lib/commands/ACL_LOG.ts

@@ -21,6 +21,11 @@ export type AclLogReply = ArrayReply<TuplesToMapReply<[
 export default {
   NOT_KEYED_COMMAND: true,
   IS_READ_ONLY: true,
+  /**
+   * Returns ACL security events log entries
+   * @param parser - The Redis command parser
+   * @param count - Optional maximum number of entries to return
+   */
   parseCommand(parser: CommandParser, count?: number) {
     parser.push('ACL', 'LOG');
     if (count != undefined) {

packages/client/lib/commands/ACL_LOG_RESET.ts

@@ -5,6 +5,10 @@ import ACL_LOG from './ACL_LOG';
 export default {
   NOT_KEYED_COMMAND: true,
   IS_READ_ONLY: ACL_LOG.IS_READ_ONLY,
+  /**
+   * Clears the ACL security events log
+   * @param parser - The Redis command parser
+   */
   parseCommand(parser: CommandParser) {
     parser.push('ACL', 'LOG', 'RESET');
   },

packages/client/lib/commands/ACL_SAVE.ts

@@ -4,6 +4,10 @@ import { SimpleStringReply, Command } from '../RESP/types';
 export default {
   NOT_KEYED_COMMAND: true,
   IS_READ_ONLY: true,
+  /**
+   * Saves the current ACL configuration to the ACL file
+   * @param parser - The Redis command parser
+   */
   parseCommand(parser: CommandParser) {
     parser.push('ACL', 'SAVE');
   },