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:
@@ -22,6 +22,15 @@ export interface GeoReplyWithMember {
|
||||
|
||||
export default {
|
||||
IS_READ_ONLY: GEOSEARCH.IS_READ_ONLY,
|
||||
/**
|
||||
* Queries members inside an area of a geospatial index with additional information
|
||||
* @param parser - The Redis command parser
|
||||
* @param key - Key of the geospatial index
|
||||
* @param from - Center point of the search (member name or coordinates)
|
||||
* @param by - Search area specification (radius or box dimensions)
|
||||
* @param replyWith - Information to include with each returned member
|
||||
* @param options - Additional search options
|
||||
*/
|
||||
parseCommand(
|
||||
parser: CommandParser,
|
||||
key: RedisArgument,
|
||||
|
Reference in New Issue
Block a user