Skip to content package
@turf/helpers v7.3.2 Provides helper functions to create GeoJSON features, like points, lines, or areas on a map.
node any 2 deps esm cjs types open source
overview readme
license MIT
deps 2
unpacked 147.7 kB
files 9
node any $ npm install @turf/helpers@7.3.2n npmREADME GitHub-flavored package documentation.
downloads Across all versions.
Download trend unavailable.
compatibility Runtime metadata.
install size Estimated unpacked size across 3 packages.
253.9 kB
Includes dependencies.
dependencies 2 direct dependencies.
versions Latest published Aug 3, 2026
maintainers Registry package owners.
contents @turf/helpers
helpers
Units
Linear measurement units.
⚠️ Warning. Be aware of the implications of using radian or degree units to
measure distance. The distance represented by a degree of longitude varies
depending on latitude.
See https://www.thoughtco.com/degree-of-latitude-and-longitude-distance-4070616
for an illustration of this behaviour.
Type: ("meters" | "metres" | "m" | "millimeters" | "millimetres" | "mm" | "centimeters" | "centimetres" | "cm" | "kilometers" | "kilometres" | "km" | "miles" | "mi" | "nauticalmiles" | "nmi" | "inches" | "in" | "yards" | "yd" | "feet" | "ft" | "radians" | "rad" | "degrees" | "deg")
AreaUnits
Area measurement units.
Type: (Exclude<Units , ( | | | )> | | | | )
"radians"
"rad"
"degrees"
"deg"
"acres"
"ac"
"hectares"
"ha"
Grid Type: ("point" | "square" | "hex" | "triangle")
Corners Shorthand corner identifiers.
Type: ("sw" | "se" | "nw" | "ne" | "center" | "centroid")
Lines Geometries made up of lines i.e. lines and polygons.
AllGeoJSON Convenience type for all possible GeoJSON.
earthRadius The Earth radius in meters. Used by Turf modules that model the Earth as a sphere. The mean radius was selected because it is recommended by the Haversine formula (used by turf/distance) to reduce error.
factors Unit of measurement factors based on earthRadius.
Keys are the name of the unit, values are the number of that unit in a single radian
areaFactors Area of measurement factors based on 1 square meter.
feature
Parameters
geom (G | null)
properties GeoJsonProperties an Object of key-value pairs to add as properties (optional, default {})
options Object Optional Parameters (optional, default {})
options.bbox BBox ? Bounding Box Array [west, south, east, north] associated with the Feature
options.id Id? Identifier associated with the Feature
geometry GeometryObject input geometry
Examples var geometry = {
"type" : "Point" ,
"coordinates" : [ 110 , 50 ]
};
var feature = turf. feature (geometry);
//=feature copy
geometry Creates a GeoJSON Geometry from a Geometry string type & coordinates.
For GeometryCollection type use helpers.geometryCollection
Parameters
type ("Point" | "LineString" | "Polygon" | "MultiPoint" | "MultiLineString" | "MultiPolygon") Geometry Type
coordinates Array <any> Coordinates
_options Record<string , never> (optional, default {})
options Object Optional Parameters (optional, default {})
Examples var type = "Point" ;
var coordinates = [ 110 , 50 ];
var geometry = turf. geometry (type, coordinates);
// => geometry copy
point
Parameters
coordinates Position longitude, latitude position (each in decimal degrees)
properties GeoJsonProperties an Object of key-value pairs to add as properties (optional, default {})
options Object Optional Parameters (optional, default {})
options.bbox BBox ? Bounding Box Array [west, south, east, north] associated with the Feature
options.id Id? Identifier associated with the Feature
Examples var point = turf. point ([ - 75.343 , 39.984 ]);
//=point copy
points
Parameters
coordinates Array <Position > an array of Points
properties GeoJsonProperties Translate these properties to each Feature (optional, default {})
options Object Optional Parameters (optional, default {})
options.bbox BBox ? Bounding Box Array [west, south, east, north]
associated with the FeatureCollection
options.id Id? Identifier associated with the FeatureCollection
Examples var points = turf. points ([
[ - 75 , 39 ],
[ - 80 , 45 ],
[ - 78 , 50 ]
]);
//=points copy
polygon
Parameters
coordinates Array <Array <Position >>
properties GeoJsonProperties an Object of key-value pairs to add as properties (optional, default {})
options Object Optional Parameters (optional, default {})
options.bbox BBox ? Bounding Box Array [west, south, east, north] associated with the Feature
options.id Id? Identifier associated with the Feature
Examples var polygon = turf. polygon ([[[ - 5 , 52 ], [ - 4 , 56 ], [ - 2 , 51 ], [ - 7 , 54 ], [ - 5 , 52 ]]], { name: 'poly1' });
//=polygon copy
polygons
Parameters
coordinates Array <Array <Array <Position >>>
properties GeoJsonProperties an Object of key-value pairs to add as properties (optional, default {})
options Object Optional Parameters (optional, default {})
options.bbox BBox ? Bounding Box Array [west, south, east, north] associated with the Feature
options.id Id? Identifier associated with the FeatureCollection
Examples var polygons = turf. polygons ([
[[[ - 5 , 52 ], [ - 4 , 56 ], [ - 2 , 51 ], [ - 7 , 54 ], [ - 5 , 52 ]]],
[[[ - 15 , 42 ], [ - 14 , 46 ], [ - 12 , 41 ], [ - 17 , 44 ], [ - 15 , 42 ]]],
]);
//=polygons copy
lineString
Parameters
coordinates Array <Position > an array of Positions
properties GeoJsonProperties an Object of key-value pairs to add as properties (optional, default {})
options Object Optional Parameters (optional, default {})
options.bbox BBox ? Bounding Box Array [west, south, east, north] associated with the Feature
options.id Id? Identifier associated with the Feature
Examples var linestring1 = turf. lineString ([[ - 24 , 63 ], [ - 23 , 60 ], [ - 25 , 65 ], [ - 20 , 69 ]], {name: 'line 1' });
var linestring2 = turf. lineString ([[ - 14 , 43 ], [ - 13 , 40 ], [ - 15 , 45 ], [ - 10 , 49 ]], {name: 'line 2' });
//=linestring1
//=linestring2 copy
lineStrings
Parameters
coordinates Array <Array <Position >>
properties GeoJsonProperties an Object of key-value pairs to add as properties (optional, default {})
options Object Optional Parameters (optional, default {})
options.bbox BBox ? Bounding Box Array [west, south, east, north]
associated with the FeatureCollection
options.id Id? Identifier associated with the FeatureCollection
Examples var linestrings = turf. lineStrings ([
[[ - 24 , 63 ], [ - 23 , 60 ], [ - 25 , 65 ], [ - 20 , 69 ]],
[[ - 14 , 43 ], [ - 13 , 40 ], [ - 15 , 45 ], [ - 10 , 49 ]]
]);
//=linestrings copy
featureCollection
Parameters
features Array <Feature <GeometryObject , GeoJsonProperties >> input features
options Object Optional Parameters (optional, default {})
options.bbox BBox ? Bounding Box Array [west, south, east, north] associated with the Feature
options.id Id? Identifier associated with the Feature
Examples var locationA = turf. point ([ - 75.343 , 39.984 ], {name: 'Location A' });
var locationB = turf. point ([ - 75.833 , 39.284 ], {name: 'Location B' });
var locationC = turf. point ([ - 75.534 , 39.123 ], {name: 'Location C' });
var collection = turf. featureCollection ([
locationA,
locationB,
locationC
]);
//=collection copy
multiLineString
Parameters
coordinates Array <Array <Position >>
properties GeoJsonProperties an Object of key-value pairs to add as properties (optional, default {})
options Object Optional Parameters (optional, default {})
options.bbox BBox ? Bounding Box Array [west, south, east, north] associated with the Feature
options.id Id? Identifier associated with the Feature
Examples var multiLine = turf. multiLineString ([[[ 0 , 0 ],[ 10 , 10 ]]]);
//=multiLine copy
Throws Error if no coordinates are passed
multiPoint Creates a Feature <MultiPoint > based on a
coordinate array. Properties can be added optionally.
Parameters
coordinates Array <Position > an array of Positions
properties GeoJsonProperties an Object of key-value pairs to add as properties (optional, default {})
options Object Optional Parameters (optional, default {})
options.bbox BBox ? Bounding Box Array [west, south, east, north] associated with the Feature
options.id Id? Identifier associated with the Feature
Examples var multiPt = turf. multiPoint ([[ 0 , 0 ],[ 10 , 10 ]]);
//=multiPt copy
Throws Error if no coordinates are passed
multiPolygon Creates a Feature <MultiPolygon > based on a
coordinate array. Properties can be added optionally.
Parameters
coordinates Array <Array <Array <Position >>>
properties GeoJsonProperties an Object of key-value pairs to add as properties (optional, default {})
options Object Optional Parameters (optional, default {})
options.bbox BBox ? Bounding Box Array [west, south, east, north] associated with the Feature
options.id Id? Identifier associated with the Feature
Examples var multiPoly = turf. multiPolygon ([[[[ 0 , 0 ],[ 0 , 10 ],[ 10 , 10 ],[ 10 , 0 ],[ 0 , 0 ]]]]);
//=multiPoly copy
Throws Error if no coordinates are passed
geometryCollection Creates a Feature based on a
coordinate array. Properties can be added optionally.
Parameters
Examples var pt = turf. geometry ( "Point" , [ 100 , 0 ]);
var line = turf. geometry ( "LineString" , [[ 101 , 0 ], [ 102 , 1 ]]);
var collection = turf. geometryCollection ([pt, line]);
// => collection copy
round Round number to precision
Parameters
num number Number
precision number Precision (optional, default 0)
Examples turf. round ( 120.4321 )
//=120
turf. round ( 120.4321 , 2 )
//=120.43 copy
radiansToLength Convert a distance measurement (assuming a spherical Earth) from radians to a more friendly unit.
Valid units: miles, nauticalmiles, inches, yards, meters, metres, kilometers, centimeters, feet
Parameters
radians number in radians across the sphere
units Units can be degrees, radians, miles, inches, yards, metres,
meters, kilometres, kilometers. (optional, default "kilometers")
lengthToRadians Convert a distance measurement (assuming a spherical Earth) from a real-world unit into radians
Valid units: miles, nauticalmiles, inches, yards, meters, metres, kilometers, centimeters, feet
Parameters
distance number in real units
units Units can be degrees, radians, miles, inches, yards, metres,
meters, kilometres, kilometers. (optional, default "kilometers")
lengthToDegrees Convert a distance measurement (assuming a spherical Earth) from a real-world unit into degrees
Valid units: miles, nauticalmiles, inches, yards, meters, metres, centimeters, kilometres, feet
Parameters
distance number in real units
units Units can be degrees, radians, miles, inches, yards, metres,
meters, kilometres, kilometers. (optional, default "kilometers")
bearingToAzimuth Converts any bearing angle from the north line direction (positive clockwise)
and returns an angle between 0-360 degrees (positive clockwise), 0 being the north line
Parameters
bearing number angle, between -180 and +180 degrees
Returns number angle between 0 and 360 degrees
azimuthToBearing Converts any azimuth angle from the north line direction (positive clockwise)
and returns an angle between -180 and +180 degrees (positive clockwise), 0 being the north line
Parameters
angle number between 0 and 360 degrees
Returns number bearing between -180 and +180 degrees
radiansToDegrees Converts an angle in radians to degrees
Parameters
radians number angle in radians
Returns number degrees between 0 and 360 degrees
degreesToRadians Converts an angle in degrees to radians
Parameters
degrees number angle between 0 and 360 degrees
Returns number angle in radians
convertLength Converts a length from one unit to another.
Parameters
length number Length to be converted
originalUnit Units Input length unit (optional, default "kilometers")
finalUnit Units Returned length unit (optional, default "kilometers")
Returns number The converted length
convertArea Converts an area from one unit to another.
Parameters
area number Area to be converted
originalUnit AreaUnits Input area unit (optional, default "meters")
finalUnit AreaUnits Returned area unit (optional, default "kilometers")
Returns number The converted length
isNumber
Parameters
num any Number to validate
Examples turf. isNumber ( 123 )
//=true
turf. isNumber ( 'foo' )
//=false copy
isObject
Parameters
input any variable to validate
Examples turf. isObject ({elevation: 10 })
//=true
turf. isObject ( 'foo' )
//=false copy Returns boolean true/false, including false for Arrays and Functions
removeBbox Recursively removes bounding boxes from a GeoJSON object.
This function mutates the input GeoJSON object.
Parameters
geojson GeoJSON GeoJSON object whose bounding boxes should be removed
This module is part of the Turfjs project , an open source module collection dedicated to geographic algorithms. It is maintained in the Turfjs/turf repository, where you can create PRs and issues.
Installation Install this single module individually:
$ npm install @turf/helpers copy Or install the all-encompassing @turf/turf module that includes all modules as functions:
$ npm install @turf/turf copy