Geo Utils API Overview

geoHash

geoHash: object

Defined in: types/latlon-geohash/index.d.ts:34

Type Declaration

adjacent()

adjacent: (geoHash, direction) => any

Parameters

Parameter	Type
geoHash	string
direction	"N" | "S" | "E" | "W"

Returns

any

adjacent cell to given geohash in specified direction (N/S/E/W).

bounds()

bounds: (geoHash) => object

Parameters

Parameter	Type
geoHash	string

Returns

object

bounds of given geohash.

ne

ne: number

sw

sw: number

decode()

decode: (geoHash) => object

Parameters

Parameter	Type
geoHash	string

Returns

object

of centre of given geohash, to appropriate precision.

lat

lat: number

lon

lon: number

encode()

encode: (lat, lon, precision?) => string

encode latitude/longitude point to geohash of given precision (number of characters in resulting geohash); if precision is not specified, it is inferred from precision of latitude/longitude values.

Parameters

Parameter	Type
lat	number
lon	number
precision?	number

Returns

string

neighbours()

neighbours: (geoHash) => object

Parameters

Parameter	Type
geoHash	string

Returns

object

all 8 adjacent cells (n/ne/e/se/s/sw/w/nw) to given geohash.

n

n: number

ne

ne: number

nw

nw: number

s

s: number

se

se: number

sw

sw: number

w

w: number

---

geoJSONTypes

const geoJSONTypes: string[]

Defined in: packages/geo-utils/src/index.ts:56

Functions

geoContains()

geoContains(firstGeoEntity, secondGeoEntity): boolean

Defined in: packages/geo-utils/src/index.ts:347

Returns true if the second geometry is completely contained by the first geometry. The interiors of both geometries must intersect and, the interior and boundary of the secondary geometry must not intersect the exterior of the first geometry.

Parameters

Parameter	Type
firstGeoEntity	GeoInput
secondGeoEntity	GeoInput

Returns

boolean

---

geoContainsFP()

geoContainsFP(queryGeoEntity): (input) => boolean

Defined in: packages/geo-utils/src/index.ts:355

When provided with geoInput that acts as the argument geo-feature, it will return a function that accepts any geoInput and checks to see if the new input contains the argument geo-feature

Parameters

Parameter	Type
queryGeoEntity	GeoInput

Returns

(input): boolean

Parameters

Parameter	Type
input	unknown

Returns

boolean

---

geoDisjoint()

geoDisjoint(firstGeoEntity, secondGeoEntity): boolean

Defined in: packages/geo-utils/src/index.ts:583

Returns true if both geo entities have no overlap

Parameters

Parameter	Type
firstGeoEntity	GeoInput
secondGeoEntity	GeoInput

Returns

boolean

---

geoDisjointFP()

geoDisjointFP(queryGeoEntity): (input) => boolean

Defined in: packages/geo-utils/src/index.ts:567

Parameters

Parameter	Type
queryGeoEntity	GeoInput

Returns

(input): boolean

Parameters

Parameter	Type
input	unknown

Returns

boolean

---

geoIntersects()

geoIntersects(firstGeoEntity, secondGeoEntity): boolean

Defined in: packages/geo-utils/src/index.ts:548

Returns true if both geo entities intersect each other, if one of the input geo entity is a point, it will check if the other geo-entity contains the point

Parameters

Parameter	Type
firstGeoEntity	GeoInput
secondGeoEntity	GeoInput

Returns

boolean

---

geoIntersectsFP()

geoIntersectsFP(queryGeoEntity): (input) => boolean

Defined in: packages/geo-utils/src/index.ts:552

Parameters

Parameter	Type
queryGeoEntity	GeoInput

Returns

(input): boolean

Parameters

Parameter	Type
input	unknown

Returns

boolean

---

geoPointWithinRange()

geoPointWithinRange(startingPoint, distanceValue, point): boolean

Defined in: packages/geo-utils/src/index.ts:262

Parameters

Parameter	Type
startingPoint	GeoPointInput
distanceValue	string
point	GeoPointInput

Returns

boolean

---

geoPointWithinRangeFP()

geoPointWithinRangeFP(startingPoint, distanceValue): (input) => boolean

Defined in: packages/geo-utils/src/index.ts:277

Parameters

Parameter	Type
startingPoint	GeoPointInput
distanceValue	string

Returns

(input): boolean

Parameters

Parameter	Type
input	unknown

Returns

boolean

---

geoPolyHasPoint()

geoPolyHasPoint<G>(polygon): (fieldData) => boolean

Defined in: packages/geo-utils/src/index.ts:246

Type Parameters

Type Parameter
G extends Polygon | MultiPolygon

Parameters

Parameter	Type
polygon	G | Feature<G, GeoJsonProperties>

Returns

(fieldData): boolean

Parameters

Parameter	Type
fieldData	unknown

Returns

boolean

---

geoRelationFP()

geoRelationFP(geoShape, relation): (input) => boolean

Defined in: packages/geo-utils/src/index.ts:292

Parameters

Parameter	Type
geoShape	GeoInput
relation	GeoShapeRelation

Returns

(input): boolean

Parameters

Parameter	Type
input	unknown

Returns

boolean

---

geoWithin()

geoWithin(firstGeoEntity, secondGeoEntity): boolean

Defined in: packages/geo-utils/src/index.ts:481

Returns true if the first geometry is completely within the second geometry. The interiors of both geometries must intersect and, the interior and boundary of the first geometry must not intersect the exterior of the second geometry

Parameters

Parameter	Type
firstGeoEntity	GeoInput
secondGeoEntity	GeoInput

Returns

boolean

---

geoWithinFP()

geoWithinFP(queryGeoEntity): (input) => boolean

Defined in: packages/geo-utils/src/index.ts:489

When provided with geoInput that acts as the parent geo-feature, it will return a function that accepts any geoInput and checks to see if the new input is within the parent geo-feature

Parameters

Parameter	Type
queryGeoEntity	GeoInput

Returns

(input): boolean

Parameters

Parameter	Type
input	unknown

Returns

boolean

---

inGeoBoundingBox()

inGeoBoundingBox(top_left, bottom_right, point): boolean

Defined in: packages/geo-utils/src/index.ts:214

Parameters

Parameter	Type
top_left	GeoPointInput
bottom_right	GeoPointInput
point	GeoPointInput

Returns

boolean

---

inGeoBoundingBoxFP()

inGeoBoundingBoxFP(top_left, bottom_right): (input) => boolean

Defined in: packages/geo-utils/src/index.ts:228

Parameters

Parameter	Type
top_left	GeoPointInput
bottom_right	GeoPointInput

Returns

(input): boolean

Parameters

Parameter	Type
input	unknown

Returns

boolean

---

isGeoJSON()

isGeoJSON(input): input is GeoShape | ESGeoShape

Defined in: packages/geo-utils/src/index.ts:61

Parameters

Parameter	Type
input	unknown

Returns

input is GeoShape | ESGeoShape

---

isGeoPoint()

isGeoPoint(input): boolean

Defined in: packages/geo-utils/src/index.ts:197

Parameters

Parameter	Type
input	unknown

Returns

boolean

---

isGeoShapeMultiPolygon()

isGeoShapeMultiPolygon(input): input is GeoShapeMultiPolygon

Defined in: packages/geo-utils/src/index.ts:80

Parameters

Parameter	Type
input	unknown

Returns

input is GeoShapeMultiPolygon

---

isGeoShapePoint()

isGeoShapePoint(input): input is GeoShapePoint

Defined in: packages/geo-utils/src/index.ts:70

Parameters

Parameter	Type
input	unknown

Returns

input is GeoShapePoint

---

isGeoShapePolygon()

isGeoShapePolygon(input): input is GeoShapePolygon

Defined in: packages/geo-utils/src/index.ts:75

Parameters

Parameter	Type
input	unknown

Returns

input is GeoShapePolygon

---

lookupTimezone()

lookupTimezone(input): string

Defined in: packages/geo-utils/src/index.ts:664

Takes in a geo point like entity and returns the timezone of its location

Parameters

Parameter	Type
input	unknown

Returns

string

---

makeCoordinatesFromGeoPoint()

makeCoordinatesFromGeoPoint(point): CoordinateTuple

Defined in: packages/geo-utils/src/index.ts:242

Parameters

Parameter	Type
point	GeoPoint

Returns

CoordinateTuple

---

makeGeoBBox()

makeGeoBBox(point1, point2): Feature<Polygon, GeoJsonProperties>

Defined in: packages/geo-utils/src/index.ts:201

Parameters

Parameter	Type
point1	GeoPoint
point2	GeoPoint

Returns

Feature<Polygon, GeoJsonProperties>

---

makeGeoCircle()

makeGeoCircle(point, distance, unitVal?): Feature<Polygon, GeoJsonProperties> | undefined

Defined in: packages/geo-utils/src/index.ts:254

Parameters

Parameter	Type
point	GeoPoint
distance	number
unitVal?	GeoDistanceUnit

Returns

Feature<Polygon, GeoJsonProperties> | undefined

---

makeGeoFeature()

makeGeoFeature(geoShape): Feature<any, GeoJsonProperties> | undefined

Defined in: packages/geo-utils/src/index.ts:315

Converts a geoJSON object to its turf geo feature counterpart

Parameters

Parameter	Type
geoShape	unknown

Returns

Feature<any, GeoJsonProperties> | undefined

---

makeGeoFeatureOrThrow()

makeGeoFeatureOrThrow(geoShape): Feature<any>

Defined in: packages/geo-utils/src/index.ts:332

Converts a geoJSON object to its turf geo feature counterpart, will throw if not valid

Parameters

Parameter	Type
geoShape	unknown

Returns

Feature<any>

---

parseGeoDistance()

parseGeoDistance(str): GeoDistanceObj

Defined in: packages/geo-utils/src/index.ts:85

Parameters

Parameter	Type
str	string

Returns

GeoDistanceObj

---

parseGeoDistanceUnit()

parseGeoDistanceUnit(input): GeoDistanceUnit

Defined in: packages/geo-utils/src/index.ts:98

Parameters

Parameter	Type
input	string

Returns

GeoDistanceUnit

---

parseGeoPoint()

Call Signature

parseGeoPoint(point): GeoPoint

Defined in: packages/geo-utils/src/index.ts:155

Convert an input into a Geo Point object with lat and lon

Parameters

Parameter	Type
point	unknown

Returns

GeoPoint

Call Signature

parseGeoPoint(point, throwInvalid): GeoPoint

Defined in: packages/geo-utils/src/index.ts:156

Convert an input into a Geo Point object with lat and lon

Parameters

Parameter	Type
point	unknown
throwInvalid	true

Returns

GeoPoint

Call Signature

parseGeoPoint(point, throwInvalid): GeoPoint | null

Defined in: packages/geo-utils/src/index.ts:157

Convert an input into a Geo Point object with lat and lon

Parameters

Parameter	Type
point	unknown
throwInvalid	false

Returns

GeoPoint | null

---

polyHasHoles()

polyHasHoles(input): boolean

Defined in: packages/geo-utils/src/index.ts:651

Parameters

Parameter	Type
input	GeoShape

Returns

boolean

---

toGeoJSON()

toGeoJSON(input): GeoShape | undefined

Defined in: packages/geo-utils/src/index.ts:597

Only able to convert geo-points to either a geo-json point or a simple polygon. There is no current support for creating polygon with holes or multi-polygon as of right now. geoJSON input is made sure to be properly formatted for its type value

Parameters

Parameter	Type
input	unknown

Returns

GeoShape | undefined

---

toGeoJSONOrThrow()

toGeoJSONOrThrow(input): GeoShape

Defined in: packages/geo-utils/src/index.ts:631

Parameters

Parameter	Type
input	unknown

Returns

GeoShape

---

tzCacheLoaded()

tzCacheLoaded(): boolean

Defined in: packages/geo-utils/src/index.ts:674

Returns

boolean

---

validateListCoords()

validateListCoords(coords): any[]

Defined in: packages/geo-utils/src/index.ts:641

Parameters

Parameter	Type
coords	CoordinateTuple[]

Returns

any[]