You've already forked node-redis
mirror of
https://github.com/redis/node-redis.git
synced 2025-08-06 02:15:48 +03:00
(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
This commit is contained in:
@@ -5,6 +5,16 @@ 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);
|
||||
|
Reference in New Issue
Block a user