@turf/helpers 6.5.0 → 7.0.0-alpha.1

package/dist/js/index.js

@@ -13,13 +13,15 @@ exports.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}
  */
 exports.factors = {
     centimeters: exports.earthRadius * 100,
     centimetres: exports.earthRadius * 100,
-    degrees: exports.earthRadius / 111325,
+    degrees: 360 / (2 * Math.PI),
     feet: exports.earthRadius * 3.28084,
     inches: exports.earthRadius * 39.37,
     kilometers: exports.earthRadius / 1000,
@@ -34,29 +36,7 @@ exports.factors = {
     yards: exports.earthRadius * 1.0936,
 };
 /**
- * Units of measurement factors based on 1 meter.
- *
- * @memberof helpers
- * @type {Object}
- */
-exports.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 / exports.earthRadius,
-    yards: 1.0936133,
-};
-/**
+
  * Area of measurement factors based on 1 square meter.
  *
  * @memberof helpers
@@ -74,6 +54,7 @@ exports.areaFactors = {
     meters: 1,
     metres: 1,
     miles: 3.86e-7,
+    nauticalmiles: 2.9155334959812285e-7,
     millimeters: 1000000,
     millimetres: 1000000,
     yards: 1.195990046,
@@ -98,9 +79,8 @@ exports.areaFactors = {
  *
  * //=feature
  */
-function feature(geom, properties, options) {
-    if (options === void 0) { options = {}; }
-    var feat = { type: "Feature" };
+function feature(geom, properties, options = {}) {
+    const feat = { type: "Feature" };
     if (options.id === 0 || options.id) {
         feat.id = options.id;
     }
@@ -127,8 +107,7 @@ exports.feature = feature;
  * var geometry = turf.geometry(type, coordinates);
  * // => geometry
  */
-function geometry(type, coordinates, _options) {
-    if (_options === void 0) { _options = {}; }
+function geometry(type, coordinates, _options = {}) {
     switch (type) {
         case "Point":
             return point(coordinates).geometry;
@@ -162,8 +141,7 @@ exports.geometry = geometry;
  *
  * //=point
  */
-function point(coordinates, properties, options) {
-    if (options === void 0) { options = {}; }
+function point(coordinates, properties, options = {}) {
     if (!coordinates) {
         throw new Error("coordinates is required");
     }
@@ -176,9 +154,9 @@ 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);
 }
@@ -203,9 +181,8 @@ exports.point = point;
  *
  * //=points
  */
-function points(coordinates, properties, options) {
-    if (options === void 0) { options = {}; }
-    return featureCollection(coordinates.map(function (coords) {
+function points(coordinates, properties, options = {}) {
+    return featureCollection(coordinates.map((coords) => {
         return point(coords, properties);
     }), options);
 }
@@ -225,23 +202,24 @@ exports.points = points;
  *
  * //=polygon
  */
-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];
+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);
 }
@@ -264,9 +242,8 @@ exports.polygon = polygon;
  *
  * //=polygons
  */
-function polygons(coordinates, properties, options) {
-    if (options === void 0) { options = {}; }
-    return featureCollection(coordinates.map(function (coords) {
+function polygons(coordinates, properties, options = {}) {
+    return featureCollection(coordinates.map((coords) => {
         return polygon(coords, properties);
     }), options);
 }
@@ -288,14 +265,13 @@ exports.polygons = polygons;
  * //=linestring1
  * //=linestring2
  */
-function lineString(coordinates, properties, options) {
-    if (options === void 0) { options = {}; }
+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);
 }
@@ -319,9 +295,8 @@ exports.lineString = lineString;
  *
  * //=linestrings
  */
-function lineStrings(coordinates, properties, options) {
-    if (options === void 0) { options = {}; }
-    return featureCollection(coordinates.map(function (coords) {
+function lineStrings(coordinates, properties, options = {}) {
+    return featureCollection(coordinates.map((coords) => {
         return lineString(coords, properties);
     }), options);
 }
@@ -348,9 +323,8 @@ exports.lineStrings = lineStrings;
  *
  * //=collection
  */
-function featureCollection(features, options) {
-    if (options === void 0) { options = {}; }
-    var fc = { type: "FeatureCollection" };
+function featureCollection(features, options = {}) {
+    const fc = { type: "FeatureCollection" };
     if (options.id) {
         fc.id = options.id;
     }
@@ -378,11 +352,10 @@ exports.featureCollection = featureCollection;
  *
  * //=multiLine
  */
-function multiLineString(coordinates, properties, options) {
-    if (options === void 0) { options = {}; }
-    var geom = {
+function multiLineString(coordinates, properties, options = {}) {
+    const geom = {
         type: "MultiLineString",
-        coordinates: coordinates,
+        coordinates,
     };
     return feature(geom, properties, options);
 }
@@ -404,11 +377,10 @@ exports.multiLineString = multiLineString;
  *
  * //=multiPt
  */
-function multiPoint(coordinates, properties, options) {
-    if (options === void 0) { options = {}; }
-    var geom = {
+function multiPoint(coordinates, properties, options = {}) {
+    const geom = {
         type: "MultiPoint",
-        coordinates: coordinates,
+        coordinates,
     };
     return feature(geom, properties, options);
 }
@@ -431,11 +403,10 @@ exports.multiPoint = multiPoint;
  * //=multiPoly
  *
  */
-function multiPolygon(coordinates, properties, options) {
-    if (options === void 0) { options = {}; }
-    var geom = {
+function multiPolygon(coordinates, properties, options = {}) {
+    const geom = {
         type: "MultiPolygon",
-        coordinates: coordinates,
+        coordinates,
     };
     return feature(geom, properties, options);
 }
@@ -458,11 +429,10 @@ exports.multiPolygon = multiPolygon;
  *
  * // => collection
  */
-function geometryCollection(geometries, properties, options) {
-    if (options === void 0) { options = {}; }
-    var geom = {
+function geometryCollection(geometries, properties, options = {}) {
+    const geom = {
         type: "GeometryCollection",
-        geometries: geometries,
+        geometries,
     };
     return feature(geom, properties, options);
 }
@@ -480,12 +450,11 @@ exports.geometryCollection = geometryCollection;
  * turf.round(120.4321, 2)
  * //=120.43
  */
-function round(num, precision) {
-    if (precision === void 0) { precision = 0; }
+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;
 }
 exports.round = round;
@@ -499,9 +468,8 @@ exports.round = round;
  * meters, kilometres, kilometers.
  * @returns {number} distance
  */
-function radiansToLength(radians, units) {
-    if (units === void 0) { units = "kilometers"; }
-    var factor = exports.factors[units];
+function radiansToLength(radians, units = "kilometers") {
+    const factor = exports.factors[units];
     if (!factor) {
         throw new Error(units + " units is invalid");
     }
@@ -518,9 +486,8 @@ exports.radiansToLength = radiansToLength;
  * meters, kilometres, kilometers.
  * @returns {number} radians
  */
-function lengthToRadians(distance, units) {
-    if (units === void 0) { units = "kilometers"; }
-    var factor = exports.factors[units];
+function lengthToRadians(distance, units = "kilometers") {
+    const factor = exports.factors[units];
     if (!factor) {
         throw new Error(units + " units is invalid");
     }
@@ -550,7 +517,7 @@ exports.lengthToDegrees = lengthToDegrees;
  * @returns {number} angle between 0 and 360 degrees
  */
 function bearingToAzimuth(bearing) {
-    var angle = bearing % 360;
+    let angle = bearing % 360;
     if (angle < 0) {
         angle += 360;
     }
@@ -565,7 +532,7 @@ exports.bearingToAzimuth = bearingToAzimuth;
  * @returns {number} degrees between 0 and 360 degrees
  */
 function radiansToDegrees(radians) {
-    var degrees = radians % (2 * Math.PI);
+    const degrees = radians % (2 * Math.PI);
     return (degrees * 180) / Math.PI;
 }
 exports.radiansToDegrees = radiansToDegrees;
@@ -577,7 +544,7 @@ exports.radiansToDegrees = radiansToDegrees;
  * @returns {number} angle in radians
  */
 function degreesToRadians(degrees) {
-    var radians = degrees % 360;
+    const radians = degrees % 360;
     return (radians * Math.PI) / 180;
 }
 exports.degreesToRadians = degreesToRadians;
@@ -590,9 +557,7 @@ exports.degreesToRadians = degreesToRadians;
  * @param {Units} [finalUnit="kilometers"] returned unit
  * @returns {number} the converted length
  */
-function convertLength(length, originalUnit, finalUnit) {
-    if (originalUnit === void 0) { originalUnit = "kilometers"; }
-    if (finalUnit === void 0) { finalUnit = "kilometers"; }
+function convertLength(length, originalUnit = "kilometers", finalUnit = "kilometers") {
     if (!(length >= 0)) {
         throw new Error("length must be a positive number");
     }
@@ -607,17 +572,15 @@ exports.convertLength = convertLength;
  * @param {Units} [finalUnit="kilometers"] returned unit
  * @returns {number} the converted area
  */
-function convertArea(area, originalUnit, finalUnit) {
-    if (originalUnit === void 0) { originalUnit = "meters"; }
-    if (finalUnit === void 0) { finalUnit = "kilometers"; }
+function convertArea(area, originalUnit = "meters", finalUnit = "kilometers") {
     if (!(area >= 0)) {
         throw new Error("area must be a positive number");
     }
-    var startFactor = exports.areaFactors[originalUnit];
+    const startFactor = exports.areaFactors[originalUnit];
     if (!startFactor) {
         throw new Error("invalid original units");
     }
-    var finalFactor = exports.areaFactors[finalUnit];
+    const finalFactor = exports.areaFactors[finalUnit];
     if (!finalFactor) {
         throw new Error("invalid final units");
     }
@@ -643,7 +606,7 @@ exports.isNumber = isNumber;
  * 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
@@ -651,7 +614,7 @@ exports.isNumber = isNumber;
  * //=false
  */
 function isObject(input) {
-    return !!input && input.constructor === Object;
+    return input !== null && typeof input === "object" && !Array.isArray(input);
 }
 exports.isObject = isObject;
 /**
@@ -660,7 +623,7 @@ exports.isObject = isObject;
  * @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
@@ -685,7 +648,7 @@ 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");
         }
@@ -698,7 +661,7 @@ exports.validateBBox = validateBBox;
  * @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/js/lib/geojson.d.ts

@@ -1,193 +1,10 @@
-/**
- * GeometryTypes
- *
- * https://tools.ietf.org/html/rfc7946#section-1.4
- * The valid values for the "type" property of GeoJSON geometry objects.
- */
-export declare type GeometryTypes = "Point" | "LineString" | "Polygon" | "MultiPoint" | "MultiLineString" | "MultiPolygon" | "GeometryCollection";
-export declare type CollectionTypes = "FeatureCollection" | "GeometryCollection";
-/**
- * Types
- *
- * https://tools.ietf.org/html/rfc7946#section-1.4
- * The value values for the "type" property of GeoJSON Objects.
- */
-export declare type Types = "Feature" | GeometryTypes | CollectionTypes;
-/**
- * Bounding box
- *
- * https://tools.ietf.org/html/rfc7946#section-5
- * A GeoJSON object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections.
- * The value of the bbox member MUST be an array of length 2*n where n is the number of dimensions represented in the contained geometries,
- * with all axes of the most southwesterly point followed by all axes of the more northeasterly point.
- * The axes order of a bbox follows the axes order of geometries.
- */
-export declare type BBox2d = [number, number, number, number];
-export declare type BBox3d = [number, number, number, number, number, number];
-export declare type BBox = BBox2d | BBox3d;
 /**
  * Id
  *
  * https://tools.ietf.org/html/rfc7946#section-3.2
  * If a Feature has a commonly used identifier, that identifier SHOULD be included as a member of
  * the Feature object with the name "id", and the value of this member is either a JSON string or number.
- */
-export declare type Id = string | number;
-/**
- * Position
  *
- * https://tools.ietf.org/html/rfc7946#section-3.1.1
- * Array should contain between two and three elements.
- * The previous GeoJSON specification allowed more elements (e.g., which could be used to represent M values),
- * but the current specification only allows X, Y, and (optionally) Z to be defined.
+ * Should be contributed to @types/geojson
  */
-export declare type Position = number[];
-/**
- * Properties
- *
- * https://tools.ietf.org/html/rfc7946#section-3.2
- * A Feature object has a member with the name "properties".
- * The value of the properties member is an object (any JSON object or a JSON null value).
- */
-export declare type Properties = {
-    [name: string]: any;
-} | null;
-/**
- * Geometries
- */
-export declare type Geometries = Point | LineString | Polygon | MultiPoint | MultiLineString | MultiPolygon;
-/**
- * GeoJSON Object
- *
- * https://tools.ietf.org/html/rfc7946#section-3
- * The GeoJSON specification also allows [foreign members](https://tools.ietf.org/html/rfc7946#section-6.1)
- * Developers should use "&" type in TypeScript or extend the interface to add these foreign members.
- */
-export interface GeoJSONObject {
-    /**
-     * Specifies the type of GeoJSON object.
-     */
-    type: string;
-    /**
-     * Bounding box of the coordinate range of the object's Geometries, Features, or Feature Collections.
-     * https://tools.ietf.org/html/rfc7946#section-5
-     */
-    bbox?: BBox;
-}
-/**
- * Geometry Object
- *
- * https://tools.ietf.org/html/rfc7946#section-3
- */
-export interface GeometryObject extends GeoJSONObject {
-    type: GeometryTypes;
-}
-/**
- * Geometry
- *
- * https://tools.ietf.org/html/rfc7946#section-3
- */
-export interface Geometry extends GeoJSONObject {
-    coordinates: Position | Position[] | Position[][] | Position[][][];
-}
-/**
- * Point Geometry Object
- *
- * https://tools.ietf.org/html/rfc7946#section-3.1.2
- */
-export interface Point extends GeometryObject {
-    type: "Point";
-    coordinates: Position;
-}
-/**
- * MultiPoint Geometry Object
- *
- * https://tools.ietf.org/html/rfc7946#section-3.1.3
- */
-export interface MultiPoint extends GeometryObject {
-    type: "MultiPoint";
-    coordinates: Position[];
-}
-/**
- * LineString Geometry Object
- *
- * https://tools.ietf.org/html/rfc7946#section-3.1.4
- */
-export interface LineString extends GeometryObject {
-    type: "LineString";
-    coordinates: Position[];
-}
-/**
- * MultiLineString Geometry Object
- *
- * https://tools.ietf.org/html/rfc7946#section-3.1.5
- */
-export interface MultiLineString extends GeometryObject {
-    type: "MultiLineString";
-    coordinates: Position[][];
-}
-/**
- * Polygon Geometry Object
- *
- * https://tools.ietf.org/html/rfc7946#section-3.1.6
- */
-export interface Polygon extends GeometryObject {
-    type: "Polygon";
-    coordinates: Position[][];
-}
-/**
- * MultiPolygon Geometry Object
- *
- * https://tools.ietf.org/html/rfc7946#section-3.1.7
- */
-export interface MultiPolygon extends GeometryObject {
-    type: "MultiPolygon";
-    coordinates: Position[][][];
-}
-/**
- * GeometryCollection
- *
- * https://tools.ietf.org/html/rfc7946#section-3.1.8
- *
- * A GeoJSON object with type "GeometryCollection" is a Geometry object.
- * A GeometryCollection has a member with the name "geometries".
- * The value of "geometries" is an array.  Each element of this array is a GeoJSON Geometry object.
- * It is possible for this array to be empty.
- */
-export interface GeometryCollection extends GeometryObject {
-    type: "GeometryCollection";
-    geometries: Array<Point | LineString | Polygon | MultiPoint | MultiLineString | MultiPolygon>;
-}
-/**
- * Feature
- *
- * https://tools.ietf.org/html/rfc7946#section-3.2
- * A Feature object represents a spatially bounded thing.
- * Every Feature object is a GeoJSON object no matter where it occurs in a GeoJSON text.
- */
-export interface Feature<G = Geometry | GeometryCollection, P = Properties> extends GeoJSONObject {
-    type: "Feature";
-    geometry: G;
-    /**
-     * A value that uniquely identifies this feature in a
-     * https://tools.ietf.org/html/rfc7946#section-3.2.
-     */
-    id?: Id;
-    /**
-     * Properties associated with this feature.
-     */
-    properties: P;
-}
-/**
- * Feature Collection
- *
- * https://tools.ietf.org/html/rfc7946#section-3.3
- * A GeoJSON object with the type "FeatureCollection" is a FeatureCollection object.
- * A FeatureCollection object has a member with the name "features".
- * The value of "features" is a JSON array. Each element of the array is a Feature object as defined above.
- * It is possible for this array to be empty.
- */
-export interface FeatureCollection<G = Geometry | GeometryCollection, P = Properties> extends GeoJSONObject {
-    type: "FeatureCollection";
-    features: Array<Feature<G, P>>;
-}
+export declare type Id = string | number;

package/dist/js/lib/geojson.js

@@ -1,9 +1,2 @@
 "use strict";
-// 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
 Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/helpers",
-  "version": "6.5.0",
+  "version": "7.0.0-alpha.1",
   "description": "turf helpers module",
   "author": "Turf Authors",
   "contributors": [
@@ -33,6 +33,7 @@
   "exports": {
     "./package.json": "./package.json",
     ".": {
+      "types": "./dist/js/index.d.ts",
       "import": "./dist/es/index.js",
       "require": "./dist/js/index.js"
     }
@@ -43,23 +44,26 @@
     "dist"
   ],
   "scripts": {
-    "bench": "ts-node bench.js",
+    "bench": "tsx bench.js",
     "build": "npm-run-all build:*",
     "build:es": "tsc --outDir dist/es --module esnext --declaration false && echo '{\"type\":\"module\"}' > dist/es/package.json",
     "build:js": "tsc",
-    "docs": "node ../../scripts/generate-readmes",
+    "docs": "tsx ../../scripts/generate-readmes",
     "test": "npm-run-all test:*",
-    "test:tape": "ts-node -r esm test.js",
-    "test:types": "tsc --esModuleInterop --noEmit types.ts"
+    "test:tape": "tsx test.js",
+    "test:types": "tsc --esModuleInterop --noEmit --strict types.ts"
   },
   "devDependencies": {
     "@types/tape": "*",
     "benchmark": "*",
     "npm-run-all": "*",
     "tape": "*",
-    "ts-node": "*",
     "tslint": "*",
+    "tsx": "*",
     "typescript": "*"
   },
-  "gitHead": "5375941072b90d489389db22b43bfe809d5e451e"
+  "dependencies": {
+    "tslib": "^2.3.0"
+  },
+  "gitHead": "cf7a0c507b017ca066acffd0ce23bda5b393fb5a"
 }