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/STRAPPEND.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

33 lines
1.2 KiB
TypeScript

import { CommandParser } from '@redis/client/dist/lib/client/parser';
import { RedisArgument, Command, NullReply, NumberReply, ArrayReply } from '@redis/client/dist/lib/RESP/types';
import { transformRedisJsonArgument } from './helpers';
export interface JsonStrAppendOptions {
path?: RedisArgument;
}
export default {
IS_READ_ONLY: false,
/**
* Appends a string to a string value stored in a JSON document.
* Returns new string length after append, or null if the path doesn't exist or value is not a string.
*
* @param parser - The Redis command parser
* @param key - The key containing the JSON document
* @param append - String to append
* @param options - Optional parameters
* @param options.path - Path to the string value
*/
parseCommand(parser: CommandParser, key: RedisArgument, append: string, options?: JsonStrAppendOptions) {
parser.push('JSON.STRAPPEND');
parser.pushKey(key);
if (options?.path !== undefined) {
parser.push(options.path);
}
parser.push(transformRedisJsonArgument(append));
},
transformReply: undefined as unknown as () => NumberReply | ArrayReply<NullReply | NumberReply>
} as const satisfies Command;