1
0
mirror of https://github.com/redis/node-redis.git synced 2025-08-03 04:01:40 +03:00
Files
node-redis/packages/json/lib/commands/FORGET.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

29 lines
951 B
TypeScript

import { CommandParser } from '@redis/client/dist/lib/client/parser';
import { RedisArgument, NumberReply, Command } from '@redis/client/dist/lib/RESP/types';
export interface JsonForgetOptions {
path?: RedisArgument;
}
export default {
IS_READ_ONLY: false,
/**
* Alias for JSON.DEL - Deletes a value from a JSON document.
* Returns the number of paths deleted (0 or 1), or null if the key does not exist.
*
* @param parser - The Redis command parser
* @param key - The key containing the JSON document
* @param options - Optional parameters
* @param options.path - Path to the value to delete
*/
parseCommand(parser: CommandParser, key: RedisArgument, options?: JsonForgetOptions) {
parser.push('JSON.FORGET');
parser.pushKey(key);
if (options?.path !== undefined) {
parser.push(options.path);
}
},
transformReply: undefined as unknown as () => NumberReply
} as const satisfies Command;