geo.ST_DWithin() function

geo.ST_DWithin() is experimental and subject to change at any time.

geo.ST_DWithin() tests if the specified region is within a defined distance from the specified GIS geometry and returns true or false.

Function type signature
(distance: A, geometry: B, region: C, ?units: {distance: string}) => bool where A: Comparable + Equatable, B: Record, C: Record

For more information, see Function type signatures.



(Required) Region to test. Specify record properties for the shape.


(Required) GIS geometry to test. Can be either point or linestring geometry.


(Required) Maximum distance allowed between the region and geometry. Define distance units with the geo.units option.


Record that defines the unit of measurement for distance. Default is the geo.units option.

Was this page helpful?

Thank you for your feedback!

The future of Flux

Flux is going into maintenance mode. You can continue using it as you currently are without any changes to your code.

Read more