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

24 lines
953 B
TypeScript

import { Command } from '../RESP/types';
import { parseGeoRadiusWithArguments } from './GEORADIUS_WITH';
import GEORADIUS_WITH from './GEORADIUS_WITH';
export default {
CACHEABLE: true,
IS_READ_ONLY: true,
/**
* Read-only variant that queries members in a geospatial index based on a radius from a center point with additional information
* @param parser - The Redis command parser
* @param key - Key of the geospatial index
* @param from - Center coordinates for the search
* @param radius - Radius of the search area
* @param unit - Unit of distance (m, km, ft, mi)
* @param replyWith - Information to include with each returned member
* @param options - Additional search options
*/
parseCommand(...args: Parameters<typeof parseGeoRadiusWithArguments>) {
args[0].push('GEORADIUS_RO');
parseGeoRadiusWithArguments(...args);
},
transformReply: GEORADIUS_WITH.transformReply
} as const satisfies Command;