1
0
mirror of https://github.com/redis/node-redis.git synced 2025-12-15 23:55:38 +03:00
Files
node-redis/packages/bloom/lib/commands/bloom/INSERT.ts
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

62 lines
1.9 KiB
TypeScript

import { CommandParser } from '@redis/client/dist/lib/client/parser';
import { RedisArgument, Command } from '@redis/client/dist/lib/RESP/types';
import { RedisVariadicArgument } from '@redis/client/dist/lib/commands/generic-transformers';
import { transformBooleanArrayReply } from '@redis/client/dist/lib/commands/generic-transformers';
export interface BfInsertOptions {
CAPACITY?: number;
ERROR?: number;
EXPANSION?: number;
NOCREATE?: boolean;
NONSCALING?: boolean;
}
export default {
IS_READ_ONLY: false,
/**
* Adds one or more items to a Bloom Filter, creating it if it does not exist
* @param parser - The command parser
* @param key - The name of the Bloom filter
* @param items - One or more items to add to the filter
* @param options - Optional parameters for filter creation
* @param options.CAPACITY - Desired capacity for a new filter
* @param options.ERROR - Desired error rate for a new filter
* @param options.EXPANSION - Expansion rate for a new filter
* @param options.NOCREATE - If true, prevents automatic filter creation
* @param options.NONSCALING - Prevents the filter from creating additional sub-filters
*/
parseCommand(
parser: CommandParser,
key: RedisArgument,
items: RedisVariadicArgument,
options?: BfInsertOptions
) {
parser.push('BF.INSERT');
parser.pushKey(key);
if (options?.CAPACITY !== undefined) {
parser.push('CAPACITY', options.CAPACITY.toString());
}
if (options?.ERROR !== undefined) {
parser.push('ERROR', options.ERROR.toString());
}
if (options?.EXPANSION !== undefined) {
parser.push('EXPANSION', options.EXPANSION.toString());
}
if (options?.NOCREATE) {
parser.push('NOCREATE');
}
if (options?.NONSCALING) {
parser.push('NONSCALING');
}
parser.push('ITEMS');
parser.pushVariadic(items);
},
transformReply: transformBooleanArrayReply
} as const satisfies Command;