Monarch Database API - v1.0.0
Preparing search index...
GeospatialOperations
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
DataStructures
Index
Methods
geoadd
geodist
geohash
geopos
georadius
georadiusbymember
Methods
geoadd
geoadd
(
key
:
string
,
longitude
:
number
,
latitude
:
number
,
member
:
string
,
name
?:
string
,
)
:
Promise
<
number
>
Parameters
key
:
string
longitude
:
number
latitude
:
number
member
:
string
Optional
name
:
string
Returns
Promise
<
number
>
geodist
geodist
(
key
:
string
,
member1
:
string
,
member2
:
string
,
unit
?:
"m"
|
"km"
|
"mi"
|
"ft"
,
)
:
Promise
<
number
|
null
>
Parameters
key
:
string
member1
:
string
member2
:
string
Optional
unit
:
"m"
|
"km"
|
"mi"
|
"ft"
Returns
Promise
<
number
|
null
>
geohash
geohash
(
key
:
string
,
members
:
string
[]
)
:
Promise
<
string
[]
>
Parameters
key
:
string
members
:
string
[]
Returns
Promise
<
string
[]
>
geopos
geopos
(
key
:
string
,
members
:
string
[]
,
)
:
Promise
<
(
{
latitude
:
number
;
longitude
:
number
}
|
null
)
[]
>
Parameters
key
:
string
members
:
string
[]
Returns
Promise
<
(
{
latitude
:
number
;
longitude
:
number
}
|
null
)
[]
>
georadius
georadius
(
key
:
string
,
longitude
:
number
,
latitude
:
number
,
radius
:
number
,
unit
:
"m"
|
"km"
|
"mi"
|
"ft"
,
options
?:
{
count
?:
number
;
withCoord
?:
boolean
;
withDist
?:
boolean
}
,
)
:
Promise
<
any
[]
>
Parameters
key
:
string
longitude
:
number
latitude
:
number
radius
:
number
unit
:
"m"
|
"km"
|
"mi"
|
"ft"
Optional
options
:
{
count
?:
number
;
withCoord
?:
boolean
;
withDist
?:
boolean
}
Returns
Promise
<
any
[]
>
georadiusbymember
georadiusbymember
(
key
:
string
,
member
:
string
,
radius
:
number
,
unit
:
"m"
|
"km"
|
"mi"
|
"ft"
,
options
?:
{
count
?:
number
;
withCoord
?:
boolean
;
withDist
?:
boolean
}
,
)
:
Promise
<
any
[]
>
Parameters
key
:
string
member
:
string
radius
:
number
unit
:
"m"
|
"km"
|
"mi"
|
"ft"
Optional
options
:
{
count
?:
number
;
withCoord
?:
boolean
;
withDist
?:
boolean
}
Returns
Promise
<
any
[]
>
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
geoadd
geodist
geohash
geopos
georadius
georadiusbymember
Monarch Database API - v1.0.0
Loading...