turf-tin - npm Package Compare versions

Comparing version 3.0.10 to 3.0.12

index.js

@@ -18,3 +18,3 @@ //http://en.wikipedia.org/wiki/Delaunay_triangulation
  * @param {FeatureCollection<Point>} points input points
- * @param {String=} propertyName name of the property from which to pull z values
+ * @param {String=} z name of the property from which to pull z values
  * This is optional: if not given, then there will be no extra data added to the derived triangles.
@@ -21,0 +21,0 @@ * @return {FeatureCollection<Polygon>} TIN output

package.json

 {
   "name": "turf-tin",
-  "version": "3.0.10",
+  "version": "3.0.12",
   "description": "turf tin module",
@@ -29,4 +29,4 @@ "main": "index.js",
   "dependencies": {
-    "turf-helpers": "^3.0.10"
+    "turf-helpers": "^3.0.12"
   }
 }

README.md

 # turf-tin
 
-[![build status](https://secure.travis-ci.org/Turfjs/turf-tin.png)](http://travis-ci.org/Turfjs/turf-tin)
+# tin
 
-turf tin module
-
-
-### `turf.tin(points, propertyName)`
-
-Takes a set of Point|points and the name of a z-value property and
+Takes a set of [points](Point) and the name of a z-value property and
 creates a [Triangulated Irregular Network](http://en.wikipedia.org/wiki/Triangulated_irregular_network),
@@ -19,14 +14,11 @@ or a TIN for short, returned as a collection of Polygons. These are often used
 
+**Parameters**
 
-### Parameters
+-   `points` **FeatureCollection<Point>** input points
+-   `z` **\[[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)]** name of the property from which to pull z values
+    This is optional: if not given, then there will be no extra data added to the derived triangles.
 
-| parameter      | type                         | description                                                                                                                                                   |
-| -------------- | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `points`       | FeatureCollection\.\<Point\> | input points                                                                                                                                                  |
-| `propertyName` | String                       | _optional:_ name of the property from which to pull z values This is optional: if not given, then there will be no extra data added to the derived triangles. |
+**Examples**
 
-
-### Example
-
-```js
+```javascript
 // generate some random point data
@@ -53,9 +45,15 @@ var points = turf.random('points', 30, {
 
+Returns **FeatureCollection&lt;Polygon>** TIN output
 
-**Returns** `FeatureCollection.<Polygon>`, TIN output
+---
 
-## 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
@@ -65,8 +63,6 @@ $ npm install turf-tin
 
-## Tests
+Or install the Turf module that includes it as a function:
 
 ```sh
-$ npm test
+$ npm install turf
 ```
-
-

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

11973

decreased by-2.97%

Number of lines in readme file

66

decreased by-5.71%

Dependency changes

• Updatedturf-helpers@^3.0.12