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

41 lines
1.2 KiB
TypeScript

import { CommandParser } from '@redis/client/dist/lib/client/parser';
import { RedisArgument, TuplesReply, NumberReply, DoubleReply, UnwrapReply, Resp2Reply, Command } from '@redis/client/dist/lib/RESP/types';
export interface TsGetOptions {
LATEST?: boolean;
}
export type TsGetReply = TuplesReply<[]> | TuplesReply<[NumberReply, DoubleReply]>;
export default {
IS_READ_ONLY: true,
/**
* Gets the last sample of a time series
* @param parser - The command parser
* @param key - The key name of the time series
* @param options - Optional parameters for the command
*/
parseCommand(parser: CommandParser, key: RedisArgument, options?: TsGetOptions) {
parser.push('TS.GET');
parser.pushKey(key);
if (options?.LATEST) {
parser.push('LATEST');
}
},
transformReply: {
2(reply: UnwrapReply<Resp2Reply<TsGetReply>>) {
return reply.length === 0 ? null : {
timestamp: reply[0],
value: Number(reply[1])
};
},
3(reply: UnwrapReply<TsGetReply>) {
return reply.length === 0 ? null : {
timestamp: reply[0],
value: reply[1]
};
}
}
} as const satisfies Command;