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:
@@ -2,13 +2,25 @@ import { CommandParser } from '../client/parser';
|
||||
import { NumberReply, Command } from '../RESP/types';
|
||||
import { RedisVariadicArgument } from './generic-transformers';
|
||||
|
||||
/**
|
||||
* Options for the SINTERCARD command
|
||||
*
|
||||
* @property LIMIT - Maximum number of elements to return
|
||||
*/
|
||||
export interface SInterCardOptions {
|
||||
LIMIT?: number;
|
||||
}
|
||||
|
||||
export default {
|
||||
IS_READ_ONLY: true,
|
||||
// option `number` for backwards compatibility
|
||||
/**
|
||||
* Constructs the SINTERCARD command
|
||||
*
|
||||
* @param parser - The command parser
|
||||
* @param keys - One or more set keys to compute the intersection cardinality from
|
||||
* @param options - Options for the SINTERCARD command or a number for LIMIT (backwards compatibility)
|
||||
* @see https://redis.io/commands/sintercard/
|
||||
*/
|
||||
parseCommand(parser: CommandParser, keys: RedisVariadicArgument, options?: SInterCardOptions | number) {
|
||||
parser.push('SINTERCARD');
|
||||
parser.pushKeysLength(keys);
|
||||
|
Reference in New Issue
Block a user