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

53 lines
1.6 KiB
TypeScript

import { CommandParser } from '@redis/client/dist/lib/client/parser';
import { RedisArgument, SimpleStringReply, NullReply, Command } from '@redis/client/dist/lib/RESP/types';
import { RedisJSON, transformRedisJsonArgument } from './helpers';
export interface JsonSetOptions {
condition?: 'NX' | 'XX';
/**
* @deprecated Use `{ condition: 'NX' }` instead.
*/
NX?: boolean;
/**
* @deprecated Use `{ condition: 'XX' }` instead.
*/
XX?: boolean;
}
export default {
IS_READ_ONLY: false,
/**
* Sets a JSON value at a specific path in a JSON document.
* Returns OK on success, or null if condition (NX/XX) is not met.
*
* @param parser - The Redis command parser
* @param key - The key containing the JSON document
* @param path - Path in the document to set
* @param json - JSON value to set at the path
* @param options - Optional parameters
* @param options.condition - Set condition: NX (only if doesn't exist) or XX (only if exists)
* @deprecated options.NX - Use options.condition instead
* @deprecated options.XX - Use options.condition instead
*/
parseCommand(
parser: CommandParser,
key: RedisArgument,
path: RedisArgument,
json: RedisJSON,
options?: JsonSetOptions
) {
parser.push('JSON.SET');
parser.pushKey(key);
parser.push(path, transformRedisJsonArgument(json));
if (options?.condition) {
parser.push(options?.condition);
} else if (options?.NX) {
parser.push('NX');
} else if (options?.XX) {
parser.push('XX');
}
},
transformReply: undefined as unknown as () => SimpleStringReply<'OK'> | NullReply
} as const satisfies Command;