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

131 lines
2.6 KiB
TypeScript

import { CommandParser } from '../client/parser';
import { Command, VerbatimStringReply } from '../RESP/types';
export interface ClientInfoReply {
id: number;
addr: string;
/**
* available since 6.2
*/
laddr?: string;
fd: number;
name: string;
age: number;
idle: number;
flags: string;
db: number;
sub: number;
psub: number;
/**
* available since 7.0.3
*/
ssub?: number;
multi: number;
qbuf: number;
qbufFree: number;
/**
* available since 6.0
*/
argvMem?: number;
/**
* available since 7.0
*/
multiMem?: number;
obl: number;
oll: number;
omem: number;
/**
* available since 6.0
*/
totMem?: number;
events: string;
cmd: string;
/**
* available since 6.0
*/
user?: string;
/**
* available since 6.2
*/
redir?: number;
/**
* available since 7.0
*/
resp?: number;
/**
* available since 7.0
*/
libName?: string;
/**
* available since 7.0
*/
libVer?: string;
}
const CLIENT_INFO_REGEX = /([^\s=]+)=([^\s]*)/g;
export default {
NOT_KEYED_COMMAND: true,
IS_READ_ONLY: true,
/**
* Returns information and statistics about the current client connection
* @param parser - The Redis command parser
*/
parseCommand(parser: CommandParser) {
parser.push('CLIENT', 'INFO');
},
transformReply(rawReply: VerbatimStringReply) {
const map: Record<string, string> = {};
for (const item of rawReply.toString().matchAll(CLIENT_INFO_REGEX)) {
map[item[1]] = item[2];
}
const reply: ClientInfoReply = {
id: Number(map.id),
addr: map.addr,
fd: Number(map.fd),
name: map.name,
age: Number(map.age),
idle: Number(map.idle),
flags: map.flags,
db: Number(map.db),
sub: Number(map.sub),
psub: Number(map.psub),
multi: Number(map.multi),
qbuf: Number(map.qbuf),
qbufFree: Number(map['qbuf-free']),
argvMem: Number(map['argv-mem']),
obl: Number(map.obl),
oll: Number(map.oll),
omem: Number(map.omem),
totMem: Number(map['tot-mem']),
events: map.events,
cmd: map.cmd,
user: map.user,
libName: map['lib-name'],
libVer: map['lib-ver']
};
if (map.laddr !== undefined) {
reply.laddr = map.laddr;
}
if (map.redir !== undefined) {
reply.redir = Number(map.redir);
}
if (map.ssub !== undefined) {
reply.ssub = Number(map.ssub);
}
if (map['multi-mem'] !== undefined) {
reply.multiMem = Number(map['multi-mem']);
}
if (map.resp !== undefined) {
reply.resp = Number(map.resp);
}
return reply;
}
} as const satisfies Command;