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/GEOSEARCHSTORE.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

42 lines
1.3 KiB
TypeScript

import { CommandParser } from '../client/parser';
import { RedisArgument, NumberReply, Command } from '../RESP/types';
import { GeoSearchFrom, GeoSearchBy, GeoSearchOptions, parseGeoSearchArguments } from './GEOSEARCH';
export interface GeoSearchStoreOptions extends GeoSearchOptions {
STOREDIST?: boolean;
}
export default {
IS_READ_ONLY: false,
/**
* Searches a geospatial index and stores the results in a new sorted set
* @param parser - The Redis command parser
* @param destination - Key to store the results
* @param source - Key of the geospatial index to search
* @param from - Center point of the search (member name or coordinates)
* @param by - Search area specification (radius or box dimensions)
* @param options - Additional search and storage options
*/
parseCommand(
parser: CommandParser,
destination: RedisArgument,
source: RedisArgument,
from: GeoSearchFrom,
by: GeoSearchBy,
options?: GeoSearchStoreOptions
) {
parser.push('GEOSEARCHSTORE');
if (destination !== undefined) {
parser.pushKey(destination);
}
parseGeoSearchArguments(parser, source, from, by, options);
if (options?.STOREDIST) {
parser.push('STOREDIST');
}
},
transformReply: undefined as unknown as () => NumberReply
} as const satisfies Command;