Geo Utils API Overview

geoHash

const geoHash: object

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

latlon-geohash is an ES module whose default export is the Geohash class, with all of its methods declared static.

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

createValidGeoBox()

createValidGeoBox(topLeft, bottomRight): Feature<Polygon, GeoJsonProperties>

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

Parameters

Parameter	Type
`topLeft`	`GeoPoint`
`bottomRight`	`GeoPoint`

Returns

Feature<Polygon, GeoJsonProperties>

geoContains()

geoContains(firstGeoEntity, secondGeoEntity): boolean

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

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:381

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

geoDisjoint()

geoDisjoint(firstGeoEntity, secondGeoEntity): boolean

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

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:593

Parameters

Parameter	Type
`queryGeoEntity`	`GeoInput`

Returns

(input) => boolean

geoDistanceToMeters()

geoDistanceToMeters(distance, unit): number

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

Convert a geo distance to meters, using turf's unit factors.

SQL distance functions such as DuckDB's ST_Distance_Sphere work in meters, so a translated geoDistance(distance:"10mi") needs a meter value. Using turf gives the same number makeGeoCircle uses, so SQL queries and in-process matching agree.

turf names the unit inches where Elasticsearch uses inch, so that one is mapped.

Parameters

Parameter	Type
`distance`	`number`
`unit`	`GeoDistanceUnit`

Returns

number

geoIntersects()

geoIntersects(firstGeoEntity, secondGeoEntity): boolean

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

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:578

Parameters

Parameter	Type
`queryGeoEntity`	`GeoInput`

Returns

(input) => boolean

geoPointWithinRange()

geoPointWithinRange(startingPoint, distanceValue, point): boolean

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

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:303

Parameters

Parameter	Type
`startingPoint`	`GeoPointInput`
`distanceValue`	`string`

Returns

(input) => boolean

geoPolyHasPoint()

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

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

Type Parameters

Type Parameter
`G` extends `Polygon` \| `MultiPolygon`

Parameters

Parameter	Type
`polygon`	`G` \| `Feature`<`G`, `GeoJsonProperties`>

Returns

(fieldData) => boolean

geoRelationFP()

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

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

Parameters

Parameter	Type
`geoShape`	`GeoInput`
`relation`	`GeoShapeRelation`

Returns

(input) => boolean

geoWithin()

geoWithin(firstGeoEntity, secondGeoEntity): boolean

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

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:515

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

inGeoBoundingBox()

inGeoBoundingBox(top_left, bottom_right, point): boolean

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

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:246

Parameters

Parameter	Type
`top_left`	`GeoPointInput`
`bottom_right`	`GeoPointInput`

Returns

(input) => 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:211

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:690

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:268

Parameters

Parameter	Type
`point`	`GeoPoint`

Returns

CoordinateTuple

makeGeoCircle()

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

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

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:341

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:358

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:112

Parameters

Parameter	Type
`input`	`string`

Returns

GeoDistanceUnit

parseGeoPoint()

Call Signature

parseGeoPoint(point): GeoPoint

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

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:170

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:171

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:677

Parameters

Parameter	Type
`input`	`GeoShape`

Returns

boolean

toGeoJSON()

toGeoJSON(input): GeoShape | undefined

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

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:657

Parameters

Parameter	Type
`input`	`unknown`

Returns

GeoShape

tzCacheLoaded()

tzCacheLoaded(): boolean

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

Returns

boolean

validateBoundingBox()

validateBoundingBox(top_left, bottom_right): object

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

Parameters

Parameter	Type
`top_left`	`GeoPointInput`
`bottom_right`	`GeoPointInput`

Returns

object

bottomRight

bottomRight: GeoPoint

polygon

polygon: Feature<Polygon, GeoJsonProperties>

topLeft

topLeft: GeoPoint

validateListCoords()

validateListCoords(coords): any[]

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

Parameters

Parameter	Type
`coords`	`CoordinateTuple`[]

Returns

any[]

geoHash​

Type Declaration​

adjacent()​

Parameters​

Returns​

bounds()​

Parameters​

Returns​

ne​

sw​

decode()​

Parameters​

Returns​

lat​

lon​

encode()​

Parameters​

Returns​

neighbours()​

Parameters​

Returns​

n​

ne​

nw​

s​

se​

sw​

w​

geoJSONTypes​

Functions​

createValidGeoBox()​

Parameters​

Returns​

geoContains()​

Parameters​

Returns​

geoContainsFP()​

Parameters​

Returns​

geoDisjoint()​

Parameters​

Returns​

geoDisjointFP()​

Parameters​

Returns​

geoDistanceToMeters()​

Parameters​

Returns​

geoIntersects()​

Parameters​

Returns​

geoIntersectsFP()​

Parameters​

Returns​

geoPointWithinRange()​

Parameters​

Returns​

geoPointWithinRangeFP()​

Parameters​

Returns​

geoPolyHasPoint()​

Type Parameters​

Parameters​

Returns​

geoRelationFP()​

Parameters​

Returns​

geoWithin()​

Parameters​

Returns​

geoWithinFP()​

Parameters​

Returns​

inGeoBoundingBox()​

Parameters​

Returns​

inGeoBoundingBoxFP()​

Parameters​

Returns​

isGeoJSON()​

geoHash

Type Declaration

adjacent()

Parameters

Returns

bounds()

Parameters

Returns

ne

sw

decode()

Parameters

Returns

lat

lon

encode()

Parameters

Returns

neighbours()

Parameters

Returns

n

ne

nw

s

se

sw

w

geoJSONTypes

Functions

createValidGeoBox()

Parameters

Returns

geoContains()

Parameters

Returns

geoContainsFP()

Parameters

Returns

geoDisjoint()

Parameters

Returns

geoDisjointFP()

Parameters

Returns

geoDistanceToMeters()

Parameters

Returns

geoIntersects()

Parameters

Returns

geoIntersectsFP()

Parameters

Returns

geoPointWithinRange()

Parameters

Returns

geoPointWithinRangeFP()

Parameters

Returns

geoPolyHasPoint()

Type Parameters

Parameters

Returns

geoRelationFP()

Parameters

Returns

geoWithin()

Parameters

Returns

geoWithinFP()

Parameters

Returns

inGeoBoundingBox()

Parameters

Returns

inGeoBoundingBoxFP()

Parameters

Returns

isGeoJSON()