Monarch Database API - v1.0.0
    Preparing search index...

    Interface GeospatialOperations

    interface GeospatialOperations {
        geoadd(
            key: string,
            longitude: number,
            latitude: number,
            member: string,
            name?: string,
        ): Promise<number>;
        geodist(
            key: string,
            member1: string,
            member2: string,
            unit?: "m" | "km" | "mi" | "ft",
        ): Promise<number | null>;
        geohash(key: string, members: string[]): Promise<string[]>;
        geopos(
            key: string,
            members: string[],
        ): Promise<({ latitude: number; longitude: number } | null)[]>;
        georadius(
            key: string,
            longitude: number,
            latitude: number,
            radius: number,
            unit: "m" | "km" | "mi" | "ft",
            options?: { count?: number; withCoord?: boolean; withDist?: boolean },
        ): Promise<any[]>;
        georadiusbymember(
            key: string,
            member: string,
            radius: number,
            unit: "m" | "km" | "mi" | "ft",
            options?: { count?: number; withCoord?: boolean; withDist?: boolean },
        ): Promise<any[]>;
    }

    Implemented by

    Index

    Methods

    • Parameters

      • key: string
      • longitude: number
      • latitude: number
      • member: string
      • Optionalname: string

      Returns Promise<number>

    • Parameters

      • key: string
      • member1: string
      • member2: string
      • Optionalunit: "m" | "km" | "mi" | "ft"

      Returns Promise<number | null>

    • Parameters

      • key: string
      • members: string[]

      Returns Promise<string[]>

    • Parameters

      • key: string
      • members: string[]

      Returns Promise<({ latitude: number; longitude: number } | null)[]>

    • Parameters

      • key: string
      • longitude: number
      • latitude: number
      • radius: number
      • unit: "m" | "km" | "mi" | "ft"
      • Optionaloptions: { count?: number; withCoord?: boolean; withDist?: boolean }

      Returns Promise<any[]>

    • Parameters

      • key: string
      • member: string
      • radius: number
      • unit: "m" | "km" | "mi" | "ft"
      • Optionaloptions: { count?: number; withCoord?: boolean; withDist?: boolean }

      Returns Promise<any[]>