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

34 lines
1000 B
TypeScript

import { CommandParser } from '../client/parser';
import { RedisArgument, BlobStringReply, NullReply, Command } from '../RESP/types';
import { GeoUnits } from './GEOSEARCH';
export default {
CACHEABLE: true,
IS_READ_ONLY: true,
/**
* Returns the distance between two members in a geospatial index
* @param parser - The Redis command parser
* @param key - Key of the geospatial index
* @param member1 - First member in the geospatial index
* @param member2 - Second member in the geospatial index
* @param unit - Unit of distance (m, km, ft, mi)
*/
parseCommand(parser: CommandParser,
key: RedisArgument,
member1: RedisArgument,
member2: RedisArgument,
unit?: GeoUnits
) {
parser.push('GEODIST');
parser.pushKey(key);
parser.push(member1, member2);
if (unit) {
parser.push(unit);
}
},
transformReply(reply: BlobStringReply | NullReply) {
return reply === null ? null : Number(reply);
}
} as const satisfies Command;