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/STRLEN.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
1008 B
TypeScript

import { CommandParser } from '@redis/client/dist/lib/client/parser';
import { RedisArgument, ArrayReply, NumberReply, NullReply, Command } from '@redis/client/dist/lib/RESP/types';
export interface JsonStrLenOptions {
path?: RedisArgument;
}
export default {
IS_READ_ONLY: true,
/**
* Returns the length of a string value stored in a JSON document.
* Returns string length, array of lengths for multiple paths, or null if path doesn't 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 string value
*/
parseCommand(parser: CommandParser, key: RedisArgument, options?: JsonStrLenOptions) {
parser.push('JSON.STRLEN');
parser.pushKey(key);
if (options?.path) {
parser.push(options.path);
}
},
transformReply: undefined as unknown as () => NumberReply | ArrayReply<NumberReply | NullReply>
} as const satisfies Command;