# turf-helpers > turf geometries Latest version **3.0.12** (published 2016-07-05) · MIT license · 0 weekly downloads > **Deprecated.** This package is deprecated. ## Install ```sh npm install turf-helpers pnpm add turf-helpers yarn add turf-helpers bun add turf-helpers ``` ## Health **Score 10/100 (F)** — status: deprecated. Negative: deprecated. ## Facts | | | |---|---| | Version | 3.0.12 | | Published | 2016-07-05 | | First published | 2016-02-26 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 0 | | Known vulnerabilities | 0 | | Install scripts | no | | Author | morganherlocker | | Maintainers | tmcw | | Keywords | geo, point, turf, geojson | ## Links - npm: https://www.npmjs.com/package/turf-helpers - Repository: https://github.com/Turfjs/turf-point - Issues: https://github.com/Turfjs/turf-point/issues - npm.io page: https://npm.io/package/turf-helpers ## Alternatives - [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads - [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads - [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads - [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads - [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads ## Recent versions - 3.0.12 (latest) — 2016-07-05 - 3.0.7-canary.ae89c8b3 (canary) — 2016-06-14 - 3.0.10 — 2016-06-15 - 3.0.5 — 2016-05-17 - 3.0.1 — 2016-05-16 - 3.0.0-canary.7879bf6c — 2016-05-16 - 3.0.0-canary.2f5f7167 — 2016-05-16 - 1.0.0 — 2016-02-26 ## README # turf-helpers # feature Wraps a GeoJSON [Geometry](Geometry) in a GeoJSON [Feature](Feature). **Parameters** - `geometry` **Geometry** input geometry - `properties` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** properties **Examples** ```javascript var geometry = { "type": "Point", "coordinates": [ 67.5, 32.84267363195431 ] } var feature = turf.feature(geometry); //=feature ``` Returns **FeatureCollection** a FeatureCollection of input features # point Takes coordinates and properties (optional) and returns a new [Point](Point) feature. **Parameters** - `coordinates` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)>** longitude, latitude position (each in decimal degrees) - `properties` **\[[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)]** an Object that is used as the [Feature](Feature)'s properties **Examples** ```javascript var pt1 = turf.point([-75.343, 39.984]); //=pt1 ``` Returns **Feature<Point>** a Point feature # polygon Takes an array of LinearRings and optionally an [Object](Object) with properties and returns a [Polygon](Polygon) feature. **Parameters** - `coordinates` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)>>>** an array of LinearRings - `properties` **\[[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)]** a properties object **Examples** ```javascript var polygon = turf.polygon([[ [-2.275543, 53.464547], [-2.275543, 53.489271], [-2.215118, 53.489271], [-2.215118, 53.464547], [-2.275543, 53.464547] ]], { name: 'poly1', population: 400}); //=polygon ``` - Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** throw an error if a LinearRing of the polygon has too few positions or if a LinearRing of the Polygon does not have matching Positions at the beginning & end. Returns **Feature<Polygon>** a Polygon feature # lineString Creates a [LineString](LineString) based on a coordinate array. Properties can be added optionally. **Parameters** - `coordinates` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)>>** an array of Positions - `properties` **\[[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)]** an Object of key-value pairs to add as properties **Examples** ```javascript var linestring1 = turf.lineString([ [-21.964416, 64.148203], [-21.956176, 64.141316], [-21.93901, 64.135924], [-21.927337, 64.136673] ]); var linestring2 = turf.lineString([ [-21.929054, 64.127985], [-21.912918, 64.134726], [-21.916007, 64.141016], [-21.930084, 64.14446] ], {name: 'line 1', distance: 145}); //=linestring1 //=linestring2 ``` - Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** if no coordinates are passed Returns **Feature<LineString>** a LineString feature # featureCollection Takes one or more [Features](Feature) and creates a [FeatureCollection](FeatureCollection). **Parameters** - `features` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<Feature>** input features **Examples** ```javascript var features = [ turf.point([-75.343, 39.984], {name: 'Location A'}), turf.point([-75.833, 39.284], {name: 'Location B'}), turf.point([-75.534, 39.123], {name: 'Location C'}) ]; var fc = turf.featureCollection(features); //=fc ``` Returns **FeatureCollection** a FeatureCollection of input features # multiLineString Creates a [Feature<MultiLineString>](Feature) based on a coordinate array. Properties can be added optionally. **Parameters** - `coordinates` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)>>>** an array of LineStrings - `properties` **\[[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)]** an Object of key-value pairs to add as properties **Examples** ```javascript var multiLine = turf.multiLineString([[[0,0],[10,10]]]); //=multiLine ``` - Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** if no coordinates are passed Returns **Feature<MultiLineString>** a MultiLineString feature # multiPoint Creates a [Feature<MultiPoint>](Feature) based on a coordinate array. Properties can be added optionally. **Parameters** - `coordinates` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)>>** an array of Positions - `properties` **\[[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)]** an Object of key-value pairs to add as properties **Examples** ```javascript var multiPt = turf.multiPoint([[0,0],[10,10]]); //=multiPt ``` - Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** if no coordinates are passed Returns **Feature<MultiPoint>** a MultiPoint feature # multiPolygon Creates a [Feature<MultiPolygon>](Feature) based on a coordinate array. Properties can be added optionally. **Parameters** - `coordinates` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)>>>>** an array of Polygons - `properties` **\[[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)]** an Object of key-value pairs to add as properties **Examples** ```javascript var multiPoly = turf.multiPolygon([[[[0,0],[0,10],[10,10],[10,0],[0,0]]]); //=multiPoly ``` - Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** if no coordinates are passed Returns **Feature<MultiPolygon>** a multipolygon feature # geometryCollection Creates a [Feature<GeometryCollection>](Feature) based on a coordinate array. Properties can be added optionally. **Parameters** - `geometries` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<{Geometry}>** an array of GeoJSON Geometries - `properties` **\[[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)]** an Object of key-value pairs to add as properties **Examples** ```javascript var pt = { "type": "Point", "coordinates": [100, 0] }; var line = { "type": "LineString", "coordinates": [ [101, 0], [102, 1] ] }; var collection = turf.geometrycollection([[0,0],[10,10]]); //=collection ``` Returns **Feature<GeometryCollection>** a geometrycollection feature --- This module is part of the [Turfjs project](http://turfjs.org/), an open source module collection dedicated to geographic algorithms. It is maintained in the [Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create PRs and issues. ### Installation Install this module individually: ```sh $ npm install turf-helpers ``` Or install the Turf module that includes it as a function: ```sh $ npm install turf ``` --- _Source: https://npm.io/package/turf-helpers · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._