modules.md

point-in-geohash / Exports

point-in-geohash

Table of contents

Interfaces

• Feature
• GeoJSONProperties
• Point

Functions

• isCoordInGeohash
• isPointFeatureInGeohash
• isPointGeometryInGeohash
• randomCoordInGeohash
• randomPointFeatureInGeohash
• randomPointGeometryInGeohash

Functions

isCoordInGeohash

▸ isCoordInGeohash(latitude, longitude, geohash): boolean

Checks if a coordinate is inside a geohash

export

Parameters

Name	Type	Description
latitude	number	Latitude
longitude	number	Longitude
geohash	string	The geohash to check

Returns

boolean

Defined in

modules/inside.ts:13

---

isPointFeatureInGeohash

▸ isPointFeatureInGeohash(pointFeat, geohash): boolean

Checks if a GeoJSON Point Feature is inside a geohash

export

Parameters

Name	Type	Description
pointFeat	Feature<Point>	A GeoJSON Point Feature
geohash	string	The geohash to check

Returns

boolean

Defined in

modules/inside.ts:41

---

isPointGeometryInGeohash

▸ isPointGeometryInGeohash(pointGeom, geohash): boolean

Checks if a Point Geometry is inside a geohash

export

Parameters

Name	Type	Description
pointGeom	Point	A GeoJSON Point Geometry
geohash	string	The geohash to check

Returns

boolean

Defined in

modules/inside.ts:27

---

randomCoordInGeohash

▸ randomCoordInGeohash(geohash): [number, number]

Returns a random coordinate inside a geohash

export

Parameters

Name	Type	Description
geohash	string	Geohash to get a random position in

Returns

[number, number]

[lon, lat]

Defined in

modules/random.ts:24

---

randomPointFeatureInGeohash

▸ randomPointFeatureInGeohash(geohash, properties?): Feature<Point>

Returns a random GeoJSON Point Feature inside a geohash

export

Parameters

Name	Type	Description
geohash	string	Geohash to get a random position in
properties?	GeoJSONProperties	-

Returns

Feature<Point>

A GeoJSON Point Feature with the desired embedded properties

Defined in

modules/random.ts:50

---

randomPointGeometryInGeohash

▸ randomPointGeometryInGeohash(geohash): Point

Returns a random GeoJSON Point Geometry inside a geohash

export

Parameters

Name	Type	Description
geohash	string	Geohash to get a random position in

Returns

Point

A GeoJSON Point Geometry

Defined in

modules/random.ts:35