Comparing version 3.0.10 to 3.0.12
{ | ||
"name": "turf-area", | ||
"version": "3.0.10", | ||
"version": "3.0.12", | ||
"description": "calculate the area of a polygon or multipolygon feature", | ||
@@ -5,0 +5,0 @@ "main": "index.js", |
# turf-area | ||
[![build status](https://secure.travis-ci.org/Turfjs/turf-area.png)](http://travis-ci.org/Turfjs/turf-area) | ||
# area | ||
calculate the area of a polygon or multipolygon feature | ||
### `turf.area(input)` | ||
Takes a one or more features and returns their area | ||
in square meters. | ||
**Parameters** | ||
### Parameters | ||
- `input` **(Feature | FeatureCollection)** input features | ||
| parameter | type | description | | ||
| --------- | -------------------------- | -------------- | | ||
| `input` | Feature\,FeatureCollection | input features | | ||
**Examples** | ||
### Example | ||
```js | ||
```javascript | ||
var polygons = { | ||
@@ -62,9 +53,15 @@ "type": "FeatureCollection", | ||
Returns **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** area in square meters | ||
**Returns** `Number`, area in square meters | ||
--- | ||
## Installation | ||
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. | ||
Requires [nodejs](http://nodejs.org/). | ||
### Installation | ||
Install this module individually: | ||
```sh | ||
@@ -74,8 +71,6 @@ $ npm install turf-area | ||
## Tests | ||
Or install the Turf module that includes it as a function: | ||
```sh | ||
$ npm test | ||
$ npm install turf | ||
``` | ||
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
3964
75