@turf/helpers 6.4.0 → 7.0.0-alpha.0

package/dist/es/index.js

@@ -7,17 +7,19 @@
  * @memberof helpers
  * @type {number}
  */
-export var earthRadius = 6371008.8;
+export const earthRadius = 6371008.8;
 /**
  * Unit of measurement factors using a spherical (non-ellipsoid) earth radius.
  *
+ * Keys are the name of the unit, values are the number of that unit in a single radian
+ *
  * @memberof helpers
  * @type {Object}
  */
-export var factors = {
+export const factors = {
     centimeters: earthRadius * 100,
     centimetres: earthRadius * 100,
-    degrees: earthRadius / 111325,
+    degrees: 360 / (2 * Math.PI),
     feet: earthRadius * 3.28084,
     inches: earthRadius * 39.37,
     kilometers: earthRadius / 1000,
@@ -32,35 +34,13 @@ export var factors = {
     yards: earthRadius * 1.0936,
 };
 /**
- * Units of measurement factors based on 1 meter.
- *
- * @memberof helpers
- * @type {Object}
- */
-export var unitsFactors = {
-    centimeters: 100,
-    centimetres: 100,
-    degrees: 1 / 111325,
-    feet: 3.28084,
-    inches: 39.37,
-    kilometers: 1 / 1000,
-    kilometres: 1 / 1000,
-    meters: 1,
-    metres: 1,
-    miles: 1 / 1609.344,
-    millimeters: 1000,
-    millimetres: 1000,
-    nauticalmiles: 1 / 1852,
-    radians: 1 / earthRadius,
-    yards: 1.0936133,
-};
-/**
+
  * Area of measurement factors based on 1 square meter.
  *
  * @memberof helpers
  * @type {Object}
  */
-export var areaFactors = {
+export const areaFactors = {
     acres: 0.000247105,
     centimeters: 10000,
     centimetres: 10000,
@@ -96,9 +76,8 @@ export var areaFactors = {
  *
  * //=feature
  */
-export function feature(geom, properties, options) {
-    if (options === void 0) { options = {}; }
-    var feat = { type: "Feature" };
+export function feature(geom, properties, options = {}) {
+    const feat = { type: "Feature" };
     if (options.id === 0 || options.id) {
         feat.id = options.id;
     }
@@ -124,8 +103,7 @@ export function feature(geom, properties, options) {
  * var geometry = turf.geometry(type, coordinates);
  * // => geometry
  */
-export function geometry(type, coordinates, _options) {
-    if (_options === void 0) { _options = {}; }
+export function geometry(type, coordinates, _options = {}) {
     switch (type) {
         case "Point":
             return point(coordinates).geometry;
@@ -158,8 +136,7 @@ export function geometry(type, coordinates, _options) {
  *
  * //=point
  */
-export function point(coordinates, properties, options) {
-    if (options === void 0) { options = {}; }
+export function point(coordinates, properties, options = {}) {
     if (!coordinates) {
         throw new Error("coordinates is required");
     }
@@ -172,9 +149,9 @@ export function point(coordinates, properties, options) {
     if (!isNumber(coordinates[0]) || !isNumber(coordinates[1])) {
         throw new Error("coordinates must contain numbers");
     }
-    var geom = {
+    const geom = {
         type: "Point",
-        coordinates: coordinates,
+        coordinates,
     };
     return feature(geom, properties, options);
 }
@@ -198,9 +175,8 @@ export function point(coordinates, properties, options) {
  *
  * //=points
  */
-export function points(coordinates, properties, options) {
-    if (options === void 0) { options = {}; }
-    return featureCollection(coordinates.map(function (coords) {
+export function points(coordinates, properties, options = {}) {
+    return featureCollection(coordinates.map((coords) => {
         return point(coords, properties);
     }), options);
 }
@@ -219,23 +195,24 @@ export function points(coordinates, properties, options) {
  *
  * //=polygon
  */
-export function polygon(coordinates, properties, options) {
-    if (options === void 0) { options = {}; }
-    for (var _i = 0, coordinates_1 = coordinates; _i < coordinates_1.length; _i++) {
-        var ring = coordinates_1[_i];
+export function polygon(coordinates, properties, options = {}) {
+    for (const ring of coordinates) {
         if (ring.length < 4) {
             throw new Error("Each LinearRing of a Polygon must have 4 or more Positions.");
         }
-        for (var j = 0; j < ring[ring.length - 1].length; j++) {
+        if (ring[ring.length - 1].length !== ring[0].length) {
+            throw new Error("First and last Position are not equivalent.");
+        }
+        for (let j = 0; j < ring[ring.length - 1].length; j++) {
             // Check if first point of Polygon contains two numbers
             if (ring[ring.length - 1][j] !== ring[0][j]) {
                 throw new Error("First and last Position are not equivalent.");
             }
         }
     }
-    var geom = {
+    const geom = {
         type: "Polygon",
-        coordinates: coordinates,
+        coordinates,
     };
     return feature(geom, properties, options);
 }
@@ -257,9 +234,8 @@ export function polygon(coordinates, properties, options) {
  *
  * //=polygons
  */
-export function polygons(coordinates, properties, options) {
-    if (options === void 0) { options = {}; }
-    return featureCollection(coordinates.map(function (coords) {
+export function polygons(coordinates, properties, options = {}) {
+    return featureCollection(coordinates.map((coords) => {
         return polygon(coords, properties);
     }), options);
 }
@@ -280,14 +256,13 @@ export function polygons(coordinates, properties, options) {
  * //=linestring1
  * //=linestring2
  */
-export function lineString(coordinates, properties, options) {
-    if (options === void 0) { options = {}; }
+export function lineString(coordinates, properties, options = {}) {
     if (coordinates.length < 2) {
         throw new Error("coordinates must be an array of two or more positions");
     }
-    var geom = {
+    const geom = {
         type: "LineString",
-        coordinates: coordinates,
+        coordinates,
     };
     return feature(geom, properties, options);
 }
@@ -310,9 +285,8 @@ export function lineString(coordinates, properties, options) {
  *
  * //=linestrings
  */
-export function lineStrings(coordinates, properties, options) {
-    if (options === void 0) { options = {}; }
-    return featureCollection(coordinates.map(function (coords) {
+export function lineStrings(coordinates, properties, options = {}) {
+    return featureCollection(coordinates.map((coords) => {
         return lineString(coords, properties);
     }), options);
 }
@@ -338,9 +312,8 @@ export function lineStrings(coordinates, properties, options) {
  *
  * //=collection
  */
-export function featureCollection(features, options) {
-    if (options === void 0) { options = {}; }
-    var fc = { type: "FeatureCollection" };
+export function featureCollection(features, options = {}) {
+    const fc = { type: "FeatureCollection" };
     if (options.id) {
         fc.id = options.id;
     }
@@ -367,11 +340,10 @@ export function featureCollection(features, options) {
  *
  * //=multiLine
  */
-export function multiLineString(coordinates, properties, options) {
-    if (options === void 0) { options = {}; }
-    var geom = {
+export function multiLineString(coordinates, properties, options = {}) {
+    const geom = {
         type: "MultiLineString",
-        coordinates: coordinates,
+        coordinates,
     };
     return feature(geom, properties, options);
 }
@@ -392,11 +364,10 @@ export function multiLineString(coordinates, properties, options) {
  *
  * //=multiPt
  */
-export function multiPoint(coordinates, properties, options) {
-    if (options === void 0) { options = {}; }
-    var geom = {
+export function multiPoint(coordinates, properties, options = {}) {
+    const geom = {
         type: "MultiPoint",
-        coordinates: coordinates,
+        coordinates,
     };
     return feature(geom, properties, options);
 }
@@ -418,11 +389,10 @@ export function multiPoint(coordinates, properties, options) {
  * //=multiPoly
  *
  */
-export function multiPolygon(coordinates, properties, options) {
-    if (options === void 0) { options = {}; }
-    var geom = {
+export function multiPolygon(coordinates, properties, options = {}) {
+    const geom = {
         type: "MultiPolygon",
-        coordinates: coordinates,
+        coordinates,
     };
     return feature(geom, properties, options);
 }
@@ -444,11 +414,10 @@ export function multiPolygon(coordinates, properties, options) {
  *
  * // => collection
  */
-export function geometryCollection(geometries, properties, options) {
-    if (options === void 0) { options = {}; }
-    var geom = {
+export function geometryCollection(geometries, properties, options = {}) {
+    const geom = {
         type: "GeometryCollection",
-        geometries: geometries,
+        geometries,
     };
     return feature(geom, properties, options);
 }
@@ -465,12 +434,11 @@ export function geometryCollection(geometries, properties, options) {
  * turf.round(120.4321, 2)
  * //=120.43
  */
-export function round(num, precision) {
-    if (precision === void 0) { precision = 0; }
+export function round(num, precision = 0) {
     if (precision && !(precision >= 0)) {
         throw new Error("precision must be a positive number");
     }
-    var multiplier = Math.pow(10, precision || 0);
+    const multiplier = Math.pow(10, precision || 0);
     return Math.round(num * multiplier) / multiplier;
 }
 /**
@@ -483,9 +451,8 @@ export function round(num, precision) {
  * meters, kilometres, kilometers.
  * @returns {number} distance
  */
-export function radiansToLength(radians, units) {
-    if (units === void 0) { units = "kilometers"; }
-    var factor = factors[units];
+export function radiansToLength(radians, units = "kilometers") {
+    const factor = factors[units];
     if (!factor) {
         throw new Error(units + " units is invalid");
     }
@@ -501,9 +468,8 @@ export function radiansToLength(radians, units) {
  * meters, kilometres, kilometers.
  * @returns {number} radians
  */
-export function lengthToRadians(distance, units) {
-    if (units === void 0) { units = "kilometers"; }
-    var factor = factors[units];
+export function lengthToRadians(distance, units = "kilometers") {
+    const factor = factors[units];
     if (!factor) {
         throw new Error(units + " units is invalid");
     }
@@ -531,7 +497,7 @@ export function lengthToDegrees(distance, units) {
  * @returns {number} angle between 0 and 360 degrees
  */
 export function bearingToAzimuth(bearing) {
-    var angle = bearing % 360;
+    let angle = bearing % 360;
     if (angle < 0) {
         angle += 360;
     }
@@ -545,7 +511,7 @@ export function bearingToAzimuth(bearing) {
  * @returns {number} degrees between 0 and 360 degrees
  */
 export function radiansToDegrees(radians) {
-    var degrees = radians % (2 * Math.PI);
+    const degrees = radians % (2 * Math.PI);
     return (degrees * 180) / Math.PI;
 }
 /**
@@ -556,7 +522,7 @@ export function radiansToDegrees(radians) {
  * @returns {number} angle in radians
  */
 export function degreesToRadians(degrees) {
-    var radians = degrees % 360;
+    const radians = degrees % 360;
     return (radians * Math.PI) / 180;
 }
 /**
@@ -568,9 +534,7 @@ export function degreesToRadians(degrees) {
  * @param {Units} [finalUnit="kilometers"] returned unit
  * @returns {number} the converted length
  */
-export function convertLength(length, originalUnit, finalUnit) {
-    if (originalUnit === void 0) { originalUnit = "kilometers"; }
-    if (finalUnit === void 0) { finalUnit = "kilometers"; }
+export function convertLength(length, originalUnit = "kilometers", finalUnit = "kilometers") {
     if (!(length >= 0)) {
         throw new Error("length must be a positive number");
     }
@@ -584,17 +548,15 @@ export function convertLength(length, originalUnit, finalUnit) {
  * @param {Units} [finalUnit="kilometers"] returned unit
  * @returns {number} the converted area
  */
-export function convertArea(area, originalUnit, finalUnit) {
-    if (originalUnit === void 0) { originalUnit = "meters"; }
-    if (finalUnit === void 0) { finalUnit = "kilometers"; }
+export function convertArea(area, originalUnit = "meters", finalUnit = "kilometers") {
     if (!(area >= 0)) {
         throw new Error("area must be a positive number");
     }
-    var startFactor = areaFactors[originalUnit];
+    const startFactor = areaFactors[originalUnit];
     if (!startFactor) {
         throw new Error("invalid original units");
     }
-    var finalFactor = areaFactors[finalUnit];
+    const finalFactor = areaFactors[finalUnit];
     if (!finalFactor) {
         throw new Error("invalid final units");
     }
@@ -618,7 +580,7 @@ export function isNumber(num) {
  * isObject
  *
  * @param {*} input variable to validate
- * @returns {boolean} true/false
+ * @returns {boolean} true/false, including false for Arrays and Functions
  * @example
  * turf.isObject({elevation: 10})
  * //=true
@@ -626,7 +588,7 @@ export function isNumber(num) {
  * //=false
  */
 export function isObject(input) {
-    return !!input && input.constructor === Object;
+    return input !== null && typeof input === "object" && !Array.isArray(input);
 }
 /**
  * Validate BBox
@@ -634,7 +596,7 @@ export function isObject(input) {
  * @private
  * @param {Array<number>} bbox BBox to validate
  * @returns {void}
- * @throws Error if BBox is not valid
+ * @throws {Error} if BBox is not valid
  * @example
  * validateBBox([-180, -40, 110, 50])
  * //=OK
@@ -659,7 +621,7 @@ export function validateBBox(bbox) {
     if (bbox.length !== 4 && bbox.length !== 6) {
         throw new Error("bbox must be an Array of 4 or 6 numbers");
     }
-    bbox.forEach(function (num) {
+    bbox.forEach((num) => {
         if (!isNumber(num)) {
             throw new Error("bbox must only contain numbers");
         }
@@ -671,7 +633,7 @@ export function validateBBox(bbox) {
  * @private
  * @param {string|number} id Id to validate
  * @returns {void}
- * @throws Error if Id is not valid
+ * @throws {Error} if Id is not valid
  * @example
  * validateId([-180, -40, 110, 50])
  * //=Error

package/dist/es/lib/geojson.js

@@ -1,7 +0,0 @@
-// Type definitions for geojson 7946.0
-// Project: https://geojson.org/
-// Definitions by: Jacob Bruun <https://github.com/cobster>
-//                 Arne Schubert <https://github.com/atd-schubert>
-//                 Jeff Jacobson <https://github.com/JeffJacobson>
-// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 2.3

package/dist/js/index.d.ts

@@ -1,7 +1,8 @@
-import { BBox, CollectionTypes, Feature, FeatureCollection, GeoJSONObject, Geometries, Geometry, GeometryCollection, GeometryObject, GeometryTypes, Id, LineString, MultiLineString, MultiPoint, MultiPolygon, Point, Polygon, Position, Properties, Types } from "./lib/geojson";
-export { Id, Properties, BBox, Position, Point, LineString, Polygon, MultiPoint, MultiLineString, MultiPolygon, GeometryObject, GeoJSONObject, GeometryCollection, Geometry, GeometryTypes, Types, CollectionTypes, Geometries, Feature, FeatureCollection, };
+import { BBox, Feature, FeatureCollection, Geometry, GeometryCollection, GeometryObject, LineString, MultiLineString, MultiPoint, MultiPolygon, Point, Polygon, Position, GeoJsonProperties } from "geojson";
+import { Id } from "./lib/geojson";
+export * from "./lib/geojson";
 export declare type Coord = Feature<Point> | Point | Position;
-export declare type Units = "meters" | "millimeters" | "centimeters" | "kilometers" | "acres" | "miles" | "nauticalmiles" | "inches" | "yards" | "feet" | "radians" | "degrees" | "hectares";
+export declare type Units = "meters" | "metres" | "millimeters" | "millimetres" | "centimeters" | "centimetres" | "kilometers" | "kilometres" | "acres" | "miles" | "nauticalmiles" | "inches" | "yards" | "feet" | "radians" | "degrees" | "hectares";
 export declare type Grid = "point" | "square" | "hex" | "triangle";
 export declare type Corners = "sw" | "se" | "nw" | "ne" | "center" | "centroid";
 export declare type Lines = LineString | MultiLineString | Polygon | MultiPolygon;
@@ -15,32 +16,28 @@ export declare type AllGeoJSON = Feature | FeatureCollection | Geometry | Geomet
  * @memberof helpers
  * @type {number}
  */
-export declare let earthRadius: number;
+export declare const earthRadius = 6371008.8;
 /**
  * Unit of measurement factors using a spherical (non-ellipsoid) earth radius.
  *
- * @memberof helpers
- * @type {Object}
- */
-export declare let factors: {
-    [key: string]: number;
-};
-/**
- * Units of measurement factors based on 1 meter.
+ * Keys are the name of the unit, values are the number of that unit in a single radian
  *
  * @memberof helpers
  * @type {Object}
  */
-export declare let unitsFactors: {
+export declare const factors: {
     [key: string]: number;
 };
 /**
+
  * Area of measurement factors based on 1 square meter.
  *
  * @memberof helpers
  * @type {Object}
  */
-export declare let areaFactors: any;
+export declare const areaFactors: {
+    [key: string]: number;
+};
 /**
  * Wraps a GeoJSON {@link Geometry} in a GeoJSON {@link Feature}.
  *
@@ -61,7 +58,7 @@ export declare let areaFactors: any;
  *
  * //=feature
  */
-export declare function feature<G = Geometry, P = Properties>(geom: G, properties?: P, options?: {
+export declare function feature<G extends GeometryObject = Geometry, P = GeoJsonProperties>(geom: G | null, properties?: P, options?: {
     bbox?: BBox;
     id?: Id;
 }): Feature<G, P>;
@@ -80,7 +77,7 @@ export declare function feature<G = Geometry, P = Properties>(geom: G, propertie
  * var geometry = turf.geometry(type, coordinates);
  * // => geometry
  */
-export declare function geometry(type: "Point" | "LineString" | "Polygon" | "MultiPoint" | "MultiLineString" | "MultiPolygon", coordinates: any[], _options?: {}): Point | LineString | Polygon | MultiPoint | MultiLineString | MultiPolygon;
+export declare function geometry(type: "Point" | "LineString" | "Polygon" | "MultiPoint" | "MultiLineString" | "MultiPolygon", coordinates: any[], _options?: Record<string, never>): Point | MultiPoint | LineString | MultiLineString | Polygon | MultiPolygon;
 /**
  * Creates a {@link Point} {@link Feature} from a Position.
  *
@@ -96,7 +93,7 @@ export declare function geometry(type: "Point" | "LineString" | "Polygon" | "Mul
  *
  * //=point
  */
-export declare function point<P = Properties>(coordinates: Position, properties?: P, options?: {
+export declare function point<P = GeoJsonProperties>(coordinates: Position, properties?: P, options?: {
     bbox?: BBox;
     id?: Id;
 }): Feature<Point, P>;
@@ -120,7 +117,7 @@ export declare function point<P = Properties>(coordinates: Position, properties?
  *
  * //=points
  */
-export declare function points<P = Properties>(coordinates: Position[], properties?: P, options?: {
+export declare function points<P = GeoJsonProperties>(coordinates: Position[], properties?: P, options?: {
     bbox?: BBox;
     id?: Id;
 }): FeatureCollection<Point, P>;
@@ -139,7 +136,7 @@ export declare function points<P = Properties>(coordinates: Position[], properti
  *
  * //=polygon
  */
-export declare function polygon<P = Properties>(coordinates: Position[][], properties?: P, options?: {
+export declare function polygon<P = GeoJsonProperties>(coordinates: Position[][], properties?: P, options?: {
     bbox?: BBox;
     id?: Id;
 }): Feature<Polygon, P>;
@@ -161,7 +158,7 @@ export declare function polygon<P = Properties>(coordinates: Position[][], prope
  *
  * //=polygons
  */
-export declare function polygons<P = Properties>(coordinates: Position[][][], properties?: P, options?: {
+export declare function polygons<P = GeoJsonProperties>(coordinates: Position[][][], properties?: P, options?: {
     bbox?: BBox;
     id?: Id;
 }): FeatureCollection<Polygon, P>;
@@ -182,7 +179,7 @@ export declare function polygons<P = Properties>(coordinates: Position[][][], pr
  * //=linestring1
  * //=linestring2
  */
-export declare function lineString<P = Properties>(coordinates: Position[], properties?: P, options?: {
+export declare function lineString<P = GeoJsonProperties>(coordinates: Position[], properties?: P, options?: {
     bbox?: BBox;
     id?: Id;
 }): Feature<LineString, P>;
@@ -205,7 +202,7 @@ export declare function lineString<P = Properties>(coordinates: Position[], prop
  *
  * //=linestrings
  */
-export declare function lineStrings<P = Properties>(coordinates: Position[][], properties?: P, options?: {
+export declare function lineStrings<P = GeoJsonProperties>(coordinates: Position[][], properties?: P, options?: {
     bbox?: BBox;
     id?: Id;
 }): FeatureCollection<LineString, P>;
@@ -231,7 +228,7 @@ export declare function lineStrings<P = Properties>(coordinates: Position[][], p
  *
  * //=collection
  */
-export declare function featureCollection<G = Geometry, P = Properties>(features: Array<Feature<G, P>>, options?: {
+export declare function featureCollection<G extends GeometryObject = Geometry, P = GeoJsonProperties>(features: Array<Feature<G, P>>, options?: {
     bbox?: BBox;
     id?: Id;
 }): FeatureCollection<G, P>;
@@ -252,7 +249,7 @@ export declare function featureCollection<G = Geometry, P = Properties>(features
  *
  * //=multiLine
  */
-export declare function multiLineString<P = Properties>(coordinates: Position[][], properties?: P, options?: {
+export declare function multiLineString<P = GeoJsonProperties>(coordinates: Position[][], properties?: P, options?: {
     bbox?: BBox;
     id?: Id;
 }): Feature<MultiLineString, P>;
@@ -273,7 +270,7 @@ export declare function multiLineString<P = Properties>(coordinates: Position[][
  *
  * //=multiPt
  */
-export declare function multiPoint<P = Properties>(coordinates: Position[], properties?: P, options?: {
+export declare function multiPoint<P = GeoJsonProperties>(coordinates: Position[], properties?: P, options?: {
     bbox?: BBox;
     id?: Id;
 }): Feature<MultiPoint, P>;
@@ -295,7 +292,7 @@ export declare function multiPoint<P = Properties>(coordinates: Position[], prop
  * //=multiPoly
  *
  */
-export declare function multiPolygon<P = Properties>(coordinates: Position[][][], properties?: P, options?: {
+export declare function multiPolygon<P = GeoJsonProperties>(coordinates: Position[][][], properties?: P, options?: {
     bbox?: BBox;
     id?: Id;
 }): Feature<MultiPolygon, P>;
@@ -317,7 +314,7 @@ export declare function multiPolygon<P = Properties>(coordinates: Position[][][]
  *
  * // => collection
  */
-export declare function geometryCollection<P = Properties>(geometries: Array<Point | LineString | Polygon | MultiPoint | MultiLineString | MultiPolygon>, properties?: P, options?: {
+export declare function geometryCollection<P = GeoJsonProperties>(geometries: Array<Point | LineString | Polygon | MultiPoint | MultiLineString | MultiPolygon>, properties?: P, options?: {
     bbox?: BBox;
     id?: Id;
 }): Feature<GeometryCollection, P>;
@@ -428,7 +425,7 @@ export declare function isNumber(num: any): boolean;
  * isObject
  *
  * @param {*} input variable to validate
- * @returns {boolean} true/false
+ * @returns {boolean} true/false, including false for Arrays and Functions
  * @example
  * turf.isObject({elevation: 10})
  * //=true
@@ -442,7 +439,7 @@ export declare function isObject(input: any): boolean;
  * @private
  * @param {Array<number>} bbox BBox to validate
  * @returns {void}
- * @throws Error if BBox is not valid
+ * @throws {Error} if BBox is not valid
  * @example
  * validateBBox([-180, -40, 110, 50])
  * //=OK
@@ -464,7 +461,7 @@ export declare function validateBBox(bbox: any): void;
  * @private
  * @param {string|number} id Id to validate
  * @returns {void}
- * @throws Error if Id is not valid
+ * @throws {Error} if Id is not valid
  * @example
  * validateId([-180, -40, 110, 50])
  * //=Error