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_STORE.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

43 lines
1.4 KiB
TypeScript

import { CommandParser } from '../client/parser';
import { RedisArgument, NumberReply, Command } from '../RESP/types';
import GEORADIUS, { parseGeoRadiusArguments } from './GEORADIUS';
import { GeoCoordinates, GeoSearchOptions, GeoUnits } from './GEOSEARCH';
export interface GeoRadiusStoreOptions extends GeoSearchOptions {
STOREDIST?: boolean;
}
export default {
IS_READ_ONLY: GEORADIUS.IS_READ_ONLY,
/**
* Queries members in a geospatial index based on a radius from a center point and stores the results
* @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 destination - Key to store the results
* @param options - Additional search and storage options
*/
parseCommand(
parser: CommandParser,
key: RedisArgument,
from: GeoCoordinates,
radius: number,
unit: GeoUnits,
destination: RedisArgument,
options?: GeoRadiusStoreOptions
) {
parser.push('GEORADIUS');
parseGeoRadiusArguments(parser, key, from, radius, unit, options);
if (options?.STOREDIST) {
parser.push('STOREDIST');
parser.pushKey(destination);
} else {
parser.push('STORE');
parser.pushKey(destination);
}
},
transformReply: undefined as unknown as () => NumberReply
} as const satisfies Command;