Georedis promised

README.md

@@ -28,6 +28,8 @@ Other bonuses:
 npm install --save georedis
 ```
 
+Note: A promise-based wrapper is available via `npm install --save georedis-promised`. The API is identical, but promises are used instead of callbacks.
+
 ## Basic Usage
 Usage of this module should be extremely simple. Just make sure that your Redis server is accessible to your Node environment. Because this module uses Redis as a store, almost all methods have integrated error handling for queries.
 

index.d.ts

@@ -0,0 +1,38 @@
+import { RedisClient } from 'redis'
+export type Point = {
+  latitude: number
+  longitude: number
+}
+
+export type GeoCallback<TReply> = (err: Error, reply: TReply) => void
+
+export type NearbyOptions = {
+  withCoordinates: boolean // Will provide coordinates with locations, default false
+  withHashes: boolean // Will provide a 52bit Geohash Integer, default false
+  withDistances: boolean // Will provide distance from query, default false
+  order: 'ASC' | 'DESC' // or 'DESC' or true (same as 'ASC'), default false
+  units: 'm' | 'km' | 'mi' | 'ft' // or 'km', 'mi', 'ft', default 'm'
+  count: number // Number of results to return, default undefined
+  accurate: boolean // Useful if in emulated mode and accuracy is important, default false
+}
+
+export type GeoRedis = {
+  delete(callback?: (err: Error) => void): void
+  removeLocations(
+    locationNames: string[],
+    callback?: GeoCallback<boolean>
+  ): void
+  addLocation(
+    locationName: string,
+    position: Point,
+    callback?: GeoCallback<boolean>
+  ): void
+  nearby(
+    locationName: string,
+    radius: number,
+    options?: NearbyOptions,
+    callback?: GeoCallback<string[]>
+  ): void
+}
+
+export function initialize(client: RedisClient): GeoRedis

package.json

@@ -33,6 +33,7 @@
     "url": "https://github.com/arjunmehta/node-georedis"
   },
   "dependencies": {
+    "@types/redis": "^2.8.28",
     "geolib": "2.0.24",
     "ngeohash": "0.6.3"
   },