redis/node-redis
1
0
Fork 0
mirror of https://github.com/redis/node-redis.git synced 2025-08-07 13:22:56 +03:00
Code Activity

(docs) add jsdoc comments to command parsers (#2984)

Browse Source 
* (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:
Bobby I.
2025-06-03 14:38:07 +03:00
committed by GitHub
parent e4a1ca467f
commit 20c16e0c2c
491 changed files with 3861 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
packages/client/lib/commands/GEORADIUSBYMEMBER_RO_WITH.ts
View File

@@ -4,6 +4,15 @@ import GEORADIUSBYMEMBER_WITH, { parseGeoRadiusByMemberWithArguments } from './G
export default {
CACHEABLE: true,
IS_READ_ONLY: true,
/**
* Read-only variant that queries members in a geospatial index based on a radius from a member with additional information
* @param parser - The Redis command parser
* @param key - Key of the geospatial index
* @param from - Member name to use as center point
* @param radius - Radius of the search area
* @param unit - Unit of distance (m, km, ft, mi)
* @param withValues - Information to include with each returned member
*/
parseCommand(...args: Parameters<typeof parseGeoRadiusByMemberWithArguments>) {
const parser = args[0];
parser.push('GEORADIUSBYMEMBER_RO');