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

36 lines
1.3 KiB
TypeScript

import { CommandParser } from '@redis/client/dist/lib/client/parser';
import { RedisArgument, NumberReply, ArrayReply, NullReply, Command } from '@redis/client/dist/lib/RESP/types';
import { RedisJSON, transformRedisJsonArgument } from './helpers';
export default {
IS_READ_ONLY: false,
/**
* Inserts one or more values into an array at the specified index.
* Returns the new array length after insert, or null if the path does not exist.
*
* @param parser - The Redis command parser
* @param key - The key containing the array
* @param path - Path to the array in the JSON document
* @param index - The position where to insert the values
* @param json - The first value to insert
* @param jsons - Additional values to insert
*/
parseCommand(
parser: CommandParser,
key: RedisArgument,
path: RedisArgument,
index: number,
json: RedisJSON,
...jsons: Array<RedisJSON>
) {
parser.push('JSON.ARRINSERT');
parser.pushKey(key);
parser.push(path, index.toString(), transformRedisJsonArgument(json));
for (let i = 0; i < jsons.length; i++) {
parser.push(transformRedisJsonArgument(jsons[i]));
}
},
transformReply: undefined as unknown as () => NumberReply | ArrayReply<NumberReply | NullReply>
} as const satisfies Command;