You've already forked node-redis
mirror of
https://github.com/redis/node-redis.git
synced 2025-08-06 02:15:48 +03:00
(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
This commit is contained in:
@@ -18,6 +18,15 @@ type MultipleFieldsArguments = [...generic: GenericArguments, value: HSETObject
|
||||
export type HSETArguments = SingleFieldArguments | MultipleFieldsArguments;
|
||||
|
||||
export default {
|
||||
/**
|
||||
* Constructs the HSET command
|
||||
*
|
||||
* @param parser - The command parser
|
||||
* @param key - The key of the hash
|
||||
* @param value - Either the field name (when using single field) or an object/map/array of field-value pairs
|
||||
* @param fieldValue - The value to set (only used with single field variant)
|
||||
* @see https://redis.io/commands/hset/
|
||||
*/
|
||||
parseCommand(parser: CommandParser, ...[key, value, fieldValue]: SingleFieldArguments | MultipleFieldsArguments) {
|
||||
parser.push('HSET');
|
||||
parser.pushKey(key);
|
||||
|
Reference in New Issue
Block a user