@turf/helpers - npm Package Compare versions

Comparing version 3.6.1 to 3.6.3

index.d.ts

 /// <reference types="geojson" />
 
-export type Point = Array<number>
-export type LineString = Array<Array<number>>
-export type Polygon = Array<Array<Array<number>>>
-export type MultiPoint = Array<Point>
-export type MultiLineString = Array<LineString>
-export type MultiPolygon = Array<Polygon>
-export type Units = "miles" | "nauticalmiles" | "degrees" | "radians" | "inches" | "yards" | "meters" | "metres" | "kilometers" | "kilometres"
+export type Points = GeoJSON.FeatureCollection<GeoJSON.Point>;
+export type Point = GeoJSON.Feature<GeoJSON.Point>;
+export type MultiPoints = GeoJSON.FeatureCollection<GeoJSON.MultiPoint>;
+export type MultiPoint = GeoJSON.Feature<GeoJSON.MultiPoint>;
+export type LineStrings = GeoJSON.FeatureCollection<GeoJSON.LineString>;
+export type LineString = GeoJSON.Feature<GeoJSON.LineString>;
+export type MultiLineStrings = GeoJSON.FeatureCollection<GeoJSON.MultiLineString>;
+export type MultiLineString = GeoJSON.Feature<GeoJSON.MultiLineString>;
+export type Polygons = GeoJSON.FeatureCollection<GeoJSON.Polygon>;
+export type Polygon = GeoJSON.Feature<GeoJSON.Polygon>;
+export type MultiPolygons = GeoJSON.FeatureCollection<GeoJSON.MultiPolygon>;
+export type MultiPolygon = GeoJSON.Feature<GeoJSON.MultiPolygon>;
+export type Features = GeoJSON.FeatureCollection<any>;
+export type Feature = GeoJSON.Feature<any>;
+export type Position = GeoJSON.Position;
+export type LineStringFeatures = LineString | LineStrings | MultiLineString | MultiLineStrings | GeoJSON.LineString | GeoJSON.MultiLineString
+export type PolygonFeatures = Polygon | Polygons | MultiPolygon | MultiPolygons | GeoJSON.Polygon | GeoJSON.MultiPolygon
+export type Units = "miles" | "nauticalmiles" | "degrees" | "radians" | "inches" | "yards" | "meters" | "metres" | "kilometers" | "kilometres";
+export type BBox = Array<number>;
 
-/***
+/**
  * http://turfjs.org/docs/#feature
  */
-export function feature(geometry: GeoJSON.Feature<any>, properties?: Object): GeoJSON.Feature<any>;
+export function feature(geometry: GeoJSON.GeometryObject, properties?: any): Feature;
 
-/***
+/**
  * http://turfjs.org/docs/#point
  */
-export function point(coordinates: Point, properties?: Object): GeoJSON.Feature<GeoJSON.Point>;
+export function point(coordinates: Position, properties?: any): Point;
 
-/***
+/**
  * http://turfjs.org/docs/#polygon
  */
-export function polygon(coordinates: Polygon, properties?: Object): GeoJSON.Feature<GeoJSON.Polygon>;
+export function polygon(coordinates: Position[][], properties?: any): Polygon;
 
-/***
+/**
  * http://turfjs.org/docs/#linestring
  */
-export function lineString(coordinates: LineString, properties?: Object): GeoJSON.Feature<GeoJSON.LineString>;
+export function lineString(coordinates: Position[], properties?: any): LineString;
 
-/***
+/**
  * http://turfjs.org/docs/#featurecollection
  */
-export function featureCollection(features: Array<GeoJSON.Feature<any>>): GeoJSON.FeatureCollection<GeoJSON.MultiPoint>;
+export function featureCollection(features: Array<Feature>): MultiPoint;
 
-/***
+/**
  * http://turfjs.org/docs/#multilinestring
  */
-export function multiLineString(coordinates: MultiLineString, properties?: Object): GeoJSON.Feature<GeoJSON.MultiLineString>;
+export function multiLineString(coordinates: Position[][], properties?: any): MultiLineString;
 
-/***
+/**
  * http://turfjs.org/docs/#multipoint
  */
-export function multiPoint(coordinates: MultiPoint, properties?: Object): GeoJSON.Feature<GeoJSON.MultiPoint>;
+export function multiPoint(coordinates: Position[], properties?: any): MultiPoint;
 
-/***
+/**
  * http://turfjs.org/docs/#multipolygon
  */
-export function multiPolygon(coordinates: MultiPolygon, properties?: Object): GeoJSON.Feature<GeoJSON.MultiPolygon>;
+export function multiPolygon(coordinates: Position[][][], properties?: any): MultiPolygon;
 
-/***
+/**
  * http://turfjs.org/docs/#geometrycollection
  */
-export function geometryCollection(geometries: Array<GeoJSON.GeometryObject>, properties?: Object): GeoJSON.GeometryCollection;
+export function geometryCollection(geometries: Array<GeoJSON.GeometryObject>, properties?: any): GeoJSON.GeometryCollection;
 
-/***
+/**
  * http://turfjs.org/docs/
@@ -61,3 +73,3 @@ */
 
-/***
+/**
  * http://turfjs.org/docs/
@@ -67,5 +79,5 @@ */
 
-/***
+/**
  * http://turfjs.org/docs/
  */
 export function distanceToDegrees(distance: number, units: Units): number

index.js

@@ -271,3 +271,4 @@ /**
     kilometers: 6373,
-    kilometres: 6373
+    kilometres: 6373,
+    feet: 20908792.65
 };
@@ -280,3 +281,3 @@
  * @param {number} distance in radians across the sphere
- * @param {string=kilometers} units: one of miles, nauticalmiles, degrees, radians,
+ * @param {string} [units=kilometers] can be degrees, radians, miles, or kilometers
  * inches, yards, metres, meters, kilometres, kilometers.
@@ -298,3 +299,3 @@ * @returns {number} distance
  * @param {number} distance in real units
- * @param {string=kilometers} units: one of miles, nauticalmiles, degrees, radians,
+ * @param {string} [units=kilometers] can be degrees, radians, miles, or kilometers
  * inches, yards, metres, meters, kilometres, kilometers.
@@ -316,3 +317,3 @@ * @returns {number} radians
  * @param {number} distance in real units
- * @param {string=kilometers} units: one of miles, nauticalmiles, degrees, radians,
+ * @param {string} [units=kilometers] can be degrees, radians, miles, or kilometers
  * inches, yards, metres, meters, kilometres, kilometers.
@@ -319,0 +320,0 @@ * @returns {number} degrees

package.json

 {
   "name": "@turf/helpers",
-  "version": "3.6.1",
+  "version": "3.6.3",
   "description": "turf geometries",
@@ -5,0 +5,0 @@ "main": "index.js",

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

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

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

Improved metrics

Total package byte prevSize

32862

increased by2.4%

Lines of code

661

increased by2.01%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes