@turf/helpers 6.2.0-alpha.1 → 6.3.0

package/README.md

@@ -453,7 +453,7 @@ Returns **[number][6]** the converted length
 ## convertArea
 
 Converts a area to the requested unit.
-Valid units: kilometers, kilometres, meters, metres, centimetres, millimeters, acres, miles, yards, feet, inches
+Valid units: kilometers, kilometres, meters, metres, centimetres, millimeters, acres, miles, yards, feet, inches, hectares
 
 **Parameters**
 

package/dist/es/index.js

@@ -19,7 +19,7 @@ export var factors = {
     centimetres: earthRadius * 100,
     degrees: earthRadius / 111325,
     feet: earthRadius * 3.28084,
-    inches: earthRadius * 39.370,
+    inches: earthRadius * 39.37,
     kilometers: earthRadius / 1000,
     kilometres: earthRadius / 1000,
     meters: earthRadius,
@@ -42,7 +42,7 @@ export var unitsFactors = {
     centimetres: 100,
     degrees: 1 / 111325,
     feet: 3.28084,
-    inches: 39.370,
+    inches: 39.37,
     kilometers: 1 / 1000,
     kilometres: 1 / 1000,
     meters: 1,
@@ -65,6 +65,7 @@ export var areaFactors = {
     centimeters: 10000,
     centimetres: 10000,
     feet: 10.763910417,
+    hectares: 0.0001,
     inches: 1550.003100006,
     kilometers: 0.000001,
     kilometres: 0.000001,
@@ -123,16 +124,23 @@ 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) {
+    if (_options === void 0) { _options = {}; }
     switch (type) {
-        case "Point": return point(coordinates).geometry;
-        case "LineString": return lineString(coordinates).geometry;
-        case "Polygon": return polygon(coordinates).geometry;
-        case "MultiPoint": return multiPoint(coordinates).geometry;
-        case "MultiLineString": return multiLineString(coordinates).geometry;
-        case "MultiPolygon": return multiPolygon(coordinates).geometry;
-        default: throw new Error(type + " is invalid");
+        case "Point":
+            return point(coordinates).geometry;
+        case "LineString":
+            return lineString(coordinates).geometry;
+        case "Polygon":
+            return polygon(coordinates).geometry;
+        case "MultiPoint":
+            return multiPoint(coordinates).geometry;
+        case "MultiLineString":
+            return multiLineString(coordinates).geometry;
+        case "MultiPolygon":
+            return multiPolygon(coordinates).geometry;
+        default:
+            throw new Error(type + " is invalid");
     }
 }
 /**
@@ -152,6 +160,18 @@ export function geometry(type, coordinates, options) {
  */
 export function point(coordinates, properties, options) {
     if (options === void 0) { options = {}; }
+    if (!coordinates) {
+        throw new Error("coordinates is required");
+    }
+    if (!Array.isArray(coordinates)) {
+        throw new Error("coordinates must be an Array");
+    }
+    if (coordinates.length < 2) {
+        throw new Error("coordinates must be at least 2 numbers long");
+    }
+    if (!isNumber(coordinates[0]) || !isNumber(coordinates[1])) {
+        throw new Error("coordinates must contain numbers");
+    }
     var geom = {
         type: "Point",
         coordinates: coordinates,
@@ -459,7 +479,7 @@ export function round(num, precision) {
  *
  * @name radiansToLength
  * @param {number} radians in radians across the sphere
- * @param {string} [units="kilometers"] can be degrees, radians, miles, or kilometers inches, yards, metres,
+ * @param {string} [units="kilometers"] can be degrees, radians, miles, inches, yards, metres,
  * meters, kilometres, kilometers.
  * @returns {number} distance
  */
@@ -477,7 +497,7 @@ export function radiansToLength(radians, units) {
  *
  * @name lengthToRadians
  * @param {number} distance in real units
- * @param {string} [units="kilometers"] can be degrees, radians, miles, or kilometers inches, yards, metres,
+ * @param {string} [units="kilometers"] can be degrees, radians, miles, inches, yards, metres,
  * meters, kilometres, kilometers.
  * @returns {number} radians
  */
@@ -495,7 +515,7 @@ export function lengthToRadians(distance, units) {
  *
  * @name lengthToDegrees
  * @param {number} distance in real units
- * @param {string} [units="kilometers"] can be degrees, radians, miles, or kilometers inches, yards, metres,
+ * @param {string} [units="kilometers"] can be degrees, radians, miles, inches, yards, metres,
  * meters, kilometres, kilometers.
  * @returns {number} degrees
  */
@@ -526,7 +546,7 @@ export function bearingToAzimuth(bearing) {
  */
 export function radiansToDegrees(radians) {
     var degrees = radians % (2 * Math.PI);
-    return degrees * 180 / Math.PI;
+    return (degrees * 180) / Math.PI;
 }
 /**
  * Converts an angle in degrees to radians
@@ -537,7 +557,7 @@ export function radiansToDegrees(radians) {
  */
 export function degreesToRadians(degrees) {
     var radians = degrees % 360;
-    return radians * Math.PI / 180;
+    return (radians * Math.PI) / 180;
 }
 /**
  * Converts a length to the requested unit.
@@ -558,11 +578,11 @@ export function convertLength(length, originalUnit, finalUnit) {
 }
 /**
  * Converts a area to the requested unit.
- * Valid units: kilometers, kilometres, meters, metres, centimetres, millimeters, acres, miles, yards, feet, inches
+ * Valid units: kilometers, kilometres, meters, metres, centimetres, millimeters, acres, miles, yards, feet, inches, hectares
  * @param {number} area to be converted
  * @param {Units} [originalUnit="meters"] of the distance
  * @param {Units} [finalUnit="kilometers"] returned unit
- * @returns {number} the converted distance
+ * @returns {number} the converted area
  */
 export function convertArea(area, originalUnit, finalUnit) {
     if (originalUnit === void 0) { originalUnit = "meters"; }
@@ -606,7 +626,7 @@ export function isNumber(num) {
  * //=false
  */
 export function isObject(input) {
-    return (!!input) && (input.constructor === Object);
+    return !!input && input.constructor === Object;
 }
 /**
  * Validate BBox
@@ -674,25 +694,3 @@ export function validateId(id) {
         throw new Error("id must be a number or a string");
     }
 }
-// Deprecated methods
-export function radians2degrees() {
-    throw new Error("method has been renamed to `radiansToDegrees`");
-}
-export function degrees2radians() {
-    throw new Error("method has been renamed to `degreesToRadians`");
-}
-export function distanceToDegrees() {
-    throw new Error("method has been renamed to `lengthToDegrees`");
-}
-export function distanceToRadians() {
-    throw new Error("method has been renamed to `lengthToRadians`");
-}
-export function radiansToDistance() {
-    throw new Error("method has been renamed to `radiansToLength`");
-}
-export function bearingToAngle() {
-    throw new Error("method has been renamed to `bearingToAzimuth`");
-}
-export function convertDistance() {
-    throw new Error("method has been renamed to `convertLength`");
-}

package/dist/es/package.json

@@ -0,0 +1 @@
+{"type":"module"}

package/dist/js/index.d.ts

@@ -1,7 +1,7 @@
 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, };
 export declare type Coord = Feature<Point> | Point | Position;
-export declare type Units = "meters" | "millimeters" | "centimeters" | "kilometers" | "acres" | "miles" | "nauticalmiles" | "inches" | "yards" | "feet" | "radians" | "degrees";
+export declare type Units = "meters" | "millimeters" | "centimeters" | "kilometers" | "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;
@@ -80,7 +80,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?: {}): Point | LineString | Polygon | MultiPoint | MultiLineString | MultiPolygon;
 /**
  * Creates a {@link Point} {@link Feature} from a Position.
  *
@@ -341,7 +341,7 @@ export declare function round(num: number, precision?: number): number;
  *
  * @name radiansToLength
  * @param {number} radians in radians across the sphere
- * @param {string} [units="kilometers"] can be degrees, radians, miles, or kilometers inches, yards, metres,
+ * @param {string} [units="kilometers"] can be degrees, radians, miles, inches, yards, metres,
  * meters, kilometres, kilometers.
  * @returns {number} distance
  */
@@ -352,7 +352,7 @@ export declare function radiansToLength(radians: number, units?: Units): number;
  *
  * @name lengthToRadians
  * @param {number} distance in real units
- * @param {string} [units="kilometers"] can be degrees, radians, miles, or kilometers inches, yards, metres,
+ * @param {string} [units="kilometers"] can be degrees, radians, miles, inches, yards, metres,
  * meters, kilometres, kilometers.
  * @returns {number} radians
  */
@@ -363,7 +363,7 @@ export declare function lengthToRadians(distance: number, units?: Units): number
  *
  * @name lengthToDegrees
  * @param {number} distance in real units
- * @param {string} [units="kilometers"] can be degrees, radians, miles, or kilometers inches, yards, metres,
+ * @param {string} [units="kilometers"] can be degrees, radians, miles, inches, yards, metres,
  * meters, kilometres, kilometers.
  * @returns {number} degrees
  */
@@ -405,11 +405,11 @@ export declare function degreesToRadians(degrees: number): number;
 export declare function convertLength(length: number, originalUnit?: Units, finalUnit?: Units): number;
 /**
  * Converts a area to the requested unit.
- * Valid units: kilometers, kilometres, meters, metres, centimetres, millimeters, acres, miles, yards, feet, inches
+ * Valid units: kilometers, kilometres, meters, metres, centimetres, millimeters, acres, miles, yards, feet, inches, hectares
  * @param {number} area to be converted
  * @param {Units} [originalUnit="meters"] of the distance
  * @param {Units} [finalUnit="kilometers"] returned unit
- * @returns {number} the converted distance
+ * @returns {number} the converted area
  */
 export declare function convertArea(area: number, originalUnit?: Units, finalUnit?: Units): number;
 /**
@@ -480,10 +480,3 @@ export declare function validateBBox(bbox: any): void;
  * //=Error
  */
 export declare function validateId(id: any): void;
-export declare function radians2degrees(): void;
-export declare function degrees2radians(): void;
-export declare function distanceToDegrees(): void;
-export declare function distanceToRadians(): void;
-export declare function radiansToDistance(): void;
-export declare function bearingToAngle(): void;
-export declare function convertDistance(): void;

package/dist/js/index.js

@@ -21,7 +21,7 @@ exports.factors = {
     centimetres: exports.earthRadius * 100,
     degrees: exports.earthRadius / 111325,
     feet: exports.earthRadius * 3.28084,
-    inches: exports.earthRadius * 39.370,
+    inches: exports.earthRadius * 39.37,
     kilometers: exports.earthRadius / 1000,
     kilometres: exports.earthRadius / 1000,
     meters: exports.earthRadius,
@@ -44,7 +44,7 @@ exports.unitsFactors = {
     centimetres: 100,
     degrees: 1 / 111325,
     feet: 3.28084,
-    inches: 39.370,
+    inches: 39.37,
     kilometers: 1 / 1000,
     kilometres: 1 / 1000,
     meters: 1,
@@ -67,6 +67,7 @@ exports.areaFactors = {
     centimeters: 10000,
     centimetres: 10000,
     feet: 10.763910417,
+    hectares: 0.0001,
     inches: 1550.003100006,
     kilometers: 0.000001,
     kilometres: 0.000001,
@@ -126,16 +127,23 @@ 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) {
+    if (_options === void 0) { _options = {}; }
     switch (type) {
-        case "Point": return point(coordinates).geometry;
-        case "LineString": return lineString(coordinates).geometry;
-        case "Polygon": return polygon(coordinates).geometry;
-        case "MultiPoint": return multiPoint(coordinates).geometry;
-        case "MultiLineString": return multiLineString(coordinates).geometry;
-        case "MultiPolygon": return multiPolygon(coordinates).geometry;
-        default: throw new Error(type + " is invalid");
+        case "Point":
+            return point(coordinates).geometry;
+        case "LineString":
+            return lineString(coordinates).geometry;
+        case "Polygon":
+            return polygon(coordinates).geometry;
+        case "MultiPoint":
+            return multiPoint(coordinates).geometry;
+        case "MultiLineString":
+            return multiLineString(coordinates).geometry;
+        case "MultiPolygon":
+            return multiPolygon(coordinates).geometry;
+        default:
+            throw new Error(type + " is invalid");
     }
 }
 exports.geometry = geometry;
@@ -156,6 +164,18 @@ exports.geometry = geometry;
  */
 function point(coordinates, properties, options) {
     if (options === void 0) { options = {}; }
+    if (!coordinates) {
+        throw new Error("coordinates is required");
+    }
+    if (!Array.isArray(coordinates)) {
+        throw new Error("coordinates must be an Array");
+    }
+    if (coordinates.length < 2) {
+        throw new Error("coordinates must be at least 2 numbers long");
+    }
+    if (!isNumber(coordinates[0]) || !isNumber(coordinates[1])) {
+        throw new Error("coordinates must contain numbers");
+    }
     var geom = {
         type: "Point",
         coordinates: coordinates,
@@ -475,7 +495,7 @@ exports.round = round;
  *
  * @name radiansToLength
  * @param {number} radians in radians across the sphere
- * @param {string} [units="kilometers"] can be degrees, radians, miles, or kilometers inches, yards, metres,
+ * @param {string} [units="kilometers"] can be degrees, radians, miles, inches, yards, metres,
  * meters, kilometres, kilometers.
  * @returns {number} distance
  */
@@ -494,7 +514,7 @@ exports.radiansToLength = radiansToLength;
  *
  * @name lengthToRadians
  * @param {number} distance in real units
- * @param {string} [units="kilometers"] can be degrees, radians, miles, or kilometers inches, yards, metres,
+ * @param {string} [units="kilometers"] can be degrees, radians, miles, inches, yards, metres,
  * meters, kilometres, kilometers.
  * @returns {number} radians
  */
@@ -513,7 +533,7 @@ exports.lengthToRadians = lengthToRadians;
  *
  * @name lengthToDegrees
  * @param {number} distance in real units
- * @param {string} [units="kilometers"] can be degrees, radians, miles, or kilometers inches, yards, metres,
+ * @param {string} [units="kilometers"] can be degrees, radians, miles, inches, yards, metres,
  * meters, kilometres, kilometers.
  * @returns {number} degrees
  */
@@ -546,7 +566,7 @@ exports.bearingToAzimuth = bearingToAzimuth;
  */
 function radiansToDegrees(radians) {
     var degrees = radians % (2 * Math.PI);
-    return degrees * 180 / Math.PI;
+    return (degrees * 180) / Math.PI;
 }
 exports.radiansToDegrees = radiansToDegrees;
 /**
@@ -558,7 +578,7 @@ exports.radiansToDegrees = radiansToDegrees;
  */
 function degreesToRadians(degrees) {
     var radians = degrees % 360;
-    return radians * Math.PI / 180;
+    return (radians * Math.PI) / 180;
 }
 exports.degreesToRadians = degreesToRadians;
 /**
@@ -581,11 +601,11 @@ function convertLength(length, originalUnit, finalUnit) {
 exports.convertLength = convertLength;
 /**
  * Converts a area to the requested unit.
- * Valid units: kilometers, kilometres, meters, metres, centimetres, millimeters, acres, miles, yards, feet, inches
+ * Valid units: kilometers, kilometres, meters, metres, centimetres, millimeters, acres, miles, yards, feet, inches, hectares
  * @param {number} area to be converted
  * @param {Units} [originalUnit="meters"] of the distance
  * @param {Units} [finalUnit="kilometers"] returned unit
- * @returns {number} the converted distance
+ * @returns {number} the converted area
  */
 function convertArea(area, originalUnit, finalUnit) {
     if (originalUnit === void 0) { originalUnit = "meters"; }
@@ -631,7 +651,7 @@ exports.isNumber = isNumber;
  * //=false
  */
 function isObject(input) {
-    return (!!input) && (input.constructor === Object);
+    return !!input && input.constructor === Object;
 }
 exports.isObject = isObject;
 /**
@@ -702,32 +722,3 @@ function validateId(id) {
     }
 }
 exports.validateId = validateId;
-// Deprecated methods
-function radians2degrees() {
-    throw new Error("method has been renamed to `radiansToDegrees`");
-}
-exports.radians2degrees = radians2degrees;
-function degrees2radians() {
-    throw new Error("method has been renamed to `degreesToRadians`");
-}
-exports.degrees2radians = degrees2radians;
-function distanceToDegrees() {
-    throw new Error("method has been renamed to `lengthToDegrees`");
-}
-exports.distanceToDegrees = distanceToDegrees;
-function distanceToRadians() {
-    throw new Error("method has been renamed to `lengthToRadians`");
-}
-exports.distanceToRadians = distanceToRadians;
-function radiansToDistance() {
-    throw new Error("method has been renamed to `radiansToLength`");
-}
-exports.radiansToDistance = radiansToDistance;
-function bearingToAngle() {
-    throw new Error("method has been renamed to `bearingToAzimuth`");
-}
-exports.bearingToAngle = bearingToAngle;
-function convertDistance() {
-    throw new Error("method has been renamed to `convertLength`");
-}
-exports.convertDistance = convertDistance;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/helpers",
-  "version": "6.2.0-alpha.1",
+  "version": "6.3.0",
   "description": "turf helpers module",
   "author": "Turf Authors",
   "contributors": [
@@ -29,28 +29,36 @@
   ],
   "main": "dist/js/index.js",
   "module": "dist/es/index.js",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "import": "./dist/es/index.js",
+      "require": "./dist/js/index.js"
+    }
+  },
   "types": "dist/js/index.d.ts",
   "sideEffects": false,
   "files": [
     "dist"
   ],
   "scripts": {
-    "bench": "npm-run-all prepare bench:run",
-    "bench:run": "node bench.js",
+    "bench": "ts-node 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",
-    "prepare": "npm-run-all prepare:*",
-    "prepare:es": "tsc --outDir dist/es --module esnext --declaration false",
-    "prepare:js": "tsc",
-    "test": "npm-run-all prepare test:*",
-    "test:tape": "node -r esm test.js",
-    "test:types": "tsc --noEmit types.ts"
+    "test": "npm-run-all test:*",
+    "test:tape": "ts-node -r esm test.js",
+    "test:types": "tsc --esModuleInterop --noEmit types.ts"
   },
   "devDependencies": {
     "@types/tape": "*",
     "benchmark": "*",
+    "npm-run-all": "*",
     "tape": "*",
+    "ts-node": "*",
     "tslint": "*",
     "typescript": "*"
   },
-  "gitHead": "fc519c045a8931c1e14eab9160a7e28391f8da02"
+  "gitHead": "57c8877e1e2d67effc2cdd23385c02b2a6615a49"
 }

package/dist/es/index.d.ts

@@ -1,489 +0,0 @@
-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, };
-export declare type Coord = Feature<Point> | Point | Position;
-export declare type Units = "meters" | "millimeters" | "centimeters" | "kilometers" | "acres" | "miles" | "nauticalmiles" | "inches" | "yards" | "feet" | "radians" | "degrees";
-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;
-export declare type AllGeoJSON = Feature | FeatureCollection | Geometry | GeometryCollection;
-/**
- * @module helpers
- */
-/**
- * Earth Radius used with the Harvesine formula and approximates using a spherical (non-ellipsoid) Earth.
- *
- * @memberof helpers
- * @type {number}
- */
-export declare let earthRadius: number;
-/**
- * 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.
- *
- * @memberof helpers
- * @type {Object}
- */
-export declare let unitsFactors: {
-    [key: string]: number;
-};
-/**
- * Area of measurement factors based on 1 square meter.
- *
- * @memberof helpers
- * @type {Object}
- */
-export declare let areaFactors: any;
-/**
- * Wraps a GeoJSON {@link Geometry} in a GeoJSON {@link Feature}.
- *
- * @name feature
- * @param {Geometry} geometry input geometry
- * @param {Object} [properties={}] an Object of key-value pairs to add as properties
- * @param {Object} [options={}] Optional Parameters
- * @param {Array<number>} [options.bbox] Bounding Box Array [west, south, east, north] associated with the Feature
- * @param {string|number} [options.id] Identifier associated with the Feature
- * @returns {Feature} a GeoJSON Feature
- * @example
- * var geometry = {
- *   "type": "Point",
- *   "coordinates": [110, 50]
- * };
- *
- * var feature = turf.feature(geometry);
- *
- * //=feature
- */
-export declare function feature<G = Geometry, P = Properties>(geom: G, properties?: P, options?: {
-    bbox?: BBox;
-    id?: Id;
-}): Feature<G, P>;
-/**
- * Creates a GeoJSON {@link Geometry} from a Geometry string type & coordinates.
- * For GeometryCollection type use `helpers.geometryCollection`
- *
- * @name geometry
- * @param {string} type Geometry Type
- * @param {Array<any>} coordinates Coordinates
- * @param {Object} [options={}] Optional Parameters
- * @returns {Geometry} a GeoJSON Geometry
- * @example
- * var type = "Point";
- * var coordinates = [110, 50];
- * 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;
-/**
- * Creates a {@link Point} {@link Feature} from a Position.
- *
- * @name point
- * @param {Array<number>} coordinates longitude, latitude position (each in decimal degrees)
- * @param {Object} [properties={}] an Object of key-value pairs to add as properties
- * @param {Object} [options={}] Optional Parameters
- * @param {Array<number>} [options.bbox] Bounding Box Array [west, south, east, north] associated with the Feature
- * @param {string|number} [options.id] Identifier associated with the Feature
- * @returns {Feature<Point>} a Point feature
- * @example
- * var point = turf.point([-75.343, 39.984]);
- *
- * //=point
- */
-export declare function point<P = Properties>(coordinates: Position, properties?: P, options?: {
-    bbox?: BBox;
-    id?: Id;
-}): Feature<Point, P>;
-/**
- * Creates a {@link Point} {@link FeatureCollection} from an Array of Point coordinates.
- *
- * @name points
- * @param {Array<Array<number>>} coordinates an array of Points
- * @param {Object} [properties={}] Translate these properties to each Feature
- * @param {Object} [options={}] Optional Parameters
- * @param {Array<number>} [options.bbox] Bounding Box Array [west, south, east, north]
- * associated with the FeatureCollection
- * @param {string|number} [options.id] Identifier associated with the FeatureCollection
- * @returns {FeatureCollection<Point>} Point Feature
- * @example
- * var points = turf.points([
- *   [-75, 39],
- *   [-80, 45],
- *   [-78, 50]
- * ]);
- *
- * //=points
- */
-export declare function points<P = Properties>(coordinates: Position[], properties?: P, options?: {
-    bbox?: BBox;
-    id?: Id;
-}): FeatureCollection<Point, P>;
-/**
- * Creates a {@link Polygon} {@link Feature} from an Array of LinearRings.
- *
- * @name polygon
- * @param {Array<Array<Array<number>>>} coordinates an array of LinearRings
- * @param {Object} [properties={}] an Object of key-value pairs to add as properties
- * @param {Object} [options={}] Optional Parameters
- * @param {Array<number>} [options.bbox] Bounding Box Array [west, south, east, north] associated with the Feature
- * @param {string|number} [options.id] Identifier associated with the Feature
- * @returns {Feature<Polygon>} Polygon Feature
- * @example
- * var polygon = turf.polygon([[[-5, 52], [-4, 56], [-2, 51], [-7, 54], [-5, 52]]], { name: 'poly1' });
- *
- * //=polygon
- */
-export declare function polygon<P = Properties>(coordinates: Position[][], properties?: P, options?: {
-    bbox?: BBox;
-    id?: Id;
-}): Feature<Polygon, P>;
-/**
- * Creates a {@link Polygon} {@link FeatureCollection} from an Array of Polygon coordinates.
- *
- * @name polygons
- * @param {Array<Array<Array<Array<number>>>>} coordinates an array of Polygon coordinates
- * @param {Object} [properties={}] an Object of key-value pairs to add as properties
- * @param {Object} [options={}] Optional Parameters
- * @param {Array<number>} [options.bbox] Bounding Box Array [west, south, east, north] associated with the Feature
- * @param {string|number} [options.id] Identifier associated with the FeatureCollection
- * @returns {FeatureCollection<Polygon>} Polygon FeatureCollection
- * @example
- * var polygons = turf.polygons([
- *   [[[-5, 52], [-4, 56], [-2, 51], [-7, 54], [-5, 52]]],
- *   [[[-15, 42], [-14, 46], [-12, 41], [-17, 44], [-15, 42]]],
- * ]);
- *
- * //=polygons
- */
-export declare function polygons<P = Properties>(coordinates: Position[][][], properties?: P, options?: {
-    bbox?: BBox;
-    id?: Id;
-}): FeatureCollection<Polygon, P>;
-/**
- * Creates a {@link LineString} {@link Feature} from an Array of Positions.
- *
- * @name lineString
- * @param {Array<Array<number>>} coordinates an array of Positions
- * @param {Object} [properties={}] an Object of key-value pairs to add as properties
- * @param {Object} [options={}] Optional Parameters
- * @param {Array<number>} [options.bbox] Bounding Box Array [west, south, east, north] associated with the Feature
- * @param {string|number} [options.id] Identifier associated with the Feature
- * @returns {Feature<LineString>} LineString Feature
- * @example
- * var linestring1 = turf.lineString([[-24, 63], [-23, 60], [-25, 65], [-20, 69]], {name: 'line 1'});
- * var linestring2 = turf.lineString([[-14, 43], [-13, 40], [-15, 45], [-10, 49]], {name: 'line 2'});
- *
- * //=linestring1
- * //=linestring2
- */
-export declare function lineString<P = Properties>(coordinates: Position[], properties?: P, options?: {
-    bbox?: BBox;
-    id?: Id;
-}): Feature<LineString, P>;
-/**
- * Creates a {@link LineString} {@link FeatureCollection} from an Array of LineString coordinates.
- *
- * @name lineStrings
- * @param {Array<Array<Array<number>>>} coordinates an array of LinearRings
- * @param {Object} [properties={}] an Object of key-value pairs to add as properties
- * @param {Object} [options={}] Optional Parameters
- * @param {Array<number>} [options.bbox] Bounding Box Array [west, south, east, north]
- * associated with the FeatureCollection
- * @param {string|number} [options.id] Identifier associated with the FeatureCollection
- * @returns {FeatureCollection<LineString>} LineString FeatureCollection
- * @example
- * var linestrings = turf.lineStrings([
- *   [[-24, 63], [-23, 60], [-25, 65], [-20, 69]],
- *   [[-14, 43], [-13, 40], [-15, 45], [-10, 49]]
- * ]);
- *
- * //=linestrings
- */
-export declare function lineStrings<P = Properties>(coordinates: Position[][], properties?: P, options?: {
-    bbox?: BBox;
-    id?: Id;
-}): FeatureCollection<LineString, P>;
-/**
- * Takes one or more {@link Feature|Features} and creates a {@link FeatureCollection}.
- *
- * @name featureCollection
- * @param {Feature[]} features input features
- * @param {Object} [options={}] Optional Parameters
- * @param {Array<number>} [options.bbox] Bounding Box Array [west, south, east, north] associated with the Feature
- * @param {string|number} [options.id] Identifier associated with the Feature
- * @returns {FeatureCollection} FeatureCollection of Features
- * @example
- * var locationA = turf.point([-75.343, 39.984], {name: 'Location A'});
- * var locationB = turf.point([-75.833, 39.284], {name: 'Location B'});
- * var locationC = turf.point([-75.534, 39.123], {name: 'Location C'});
- *
- * var collection = turf.featureCollection([
- *   locationA,
- *   locationB,
- *   locationC
- * ]);
- *
- * //=collection
- */
-export declare function featureCollection<G = Geometry, P = Properties>(features: Array<Feature<G, P>>, options?: {
-    bbox?: BBox;
-    id?: Id;
-}): FeatureCollection<G, P>;
-/**
- * Creates a {@link Feature<MultiLineString>} based on a
- * coordinate array. Properties can be added optionally.
- *
- * @name multiLineString
- * @param {Array<Array<Array<number>>>} coordinates an array of LineStrings
- * @param {Object} [properties={}] an Object of key-value pairs to add as properties
- * @param {Object} [options={}] Optional Parameters
- * @param {Array<number>} [options.bbox] Bounding Box Array [west, south, east, north] associated with the Feature
- * @param {string|number} [options.id] Identifier associated with the Feature
- * @returns {Feature<MultiLineString>} a MultiLineString feature
- * @throws {Error} if no coordinates are passed
- * @example
- * var multiLine = turf.multiLineString([[[0,0],[10,10]]]);
- *
- * //=multiLine
- */
-export declare function multiLineString<P = Properties>(coordinates: Position[][], properties?: P, options?: {
-    bbox?: BBox;
-    id?: Id;
-}): Feature<MultiLineString, P>;
-/**
- * Creates a {@link Feature<MultiPoint>} based on a
- * coordinate array. Properties can be added optionally.
- *
- * @name multiPoint
- * @param {Array<Array<number>>} coordinates an array of Positions
- * @param {Object} [properties={}] an Object of key-value pairs to add as properties
- * @param {Object} [options={}] Optional Parameters
- * @param {Array<number>} [options.bbox] Bounding Box Array [west, south, east, north] associated with the Feature
- * @param {string|number} [options.id] Identifier associated with the Feature
- * @returns {Feature<MultiPoint>} a MultiPoint feature
- * @throws {Error} if no coordinates are passed
- * @example
- * var multiPt = turf.multiPoint([[0,0],[10,10]]);
- *
- * //=multiPt
- */
-export declare function multiPoint<P = Properties>(coordinates: Position[], properties?: P, options?: {
-    bbox?: BBox;
-    id?: Id;
-}): Feature<MultiPoint, P>;
-/**
- * Creates a {@link Feature<MultiPolygon>} based on a
- * coordinate array. Properties can be added optionally.
- *
- * @name multiPolygon
- * @param {Array<Array<Array<Array<number>>>>} coordinates an array of Polygons
- * @param {Object} [properties={}] an Object of key-value pairs to add as properties
- * @param {Object} [options={}] Optional Parameters
- * @param {Array<number>} [options.bbox] Bounding Box Array [west, south, east, north] associated with the Feature
- * @param {string|number} [options.id] Identifier associated with the Feature
- * @returns {Feature<MultiPolygon>} a multipolygon feature
- * @throws {Error} if no coordinates are passed
- * @example
- * var multiPoly = turf.multiPolygon([[[[0,0],[0,10],[10,10],[10,0],[0,0]]]]);
- *
- * //=multiPoly
- *
- */
-export declare function multiPolygon<P = Properties>(coordinates: Position[][][], properties?: P, options?: {
-    bbox?: BBox;
-    id?: Id;
-}): Feature<MultiPolygon, P>;
-/**
- * Creates a {@link Feature<GeometryCollection>} based on a
- * coordinate array. Properties can be added optionally.
- *
- * @name geometryCollection
- * @param {Array<Geometry>} geometries an array of GeoJSON Geometries
- * @param {Object} [properties={}] an Object of key-value pairs to add as properties
- * @param {Object} [options={}] Optional Parameters
- * @param {Array<number>} [options.bbox] Bounding Box Array [west, south, east, north] associated with the Feature
- * @param {string|number} [options.id] Identifier associated with the Feature
- * @returns {Feature<GeometryCollection>} a GeoJSON GeometryCollection Feature
- * @example
- * var pt = turf.geometry("Point", [100, 0]);
- * var line = turf.geometry("LineString", [[101, 0], [102, 1]]);
- * var collection = turf.geometryCollection([pt, line]);
- *
- * // => collection
- */
-export declare function geometryCollection<P = Properties>(geometries: Array<Point | LineString | Polygon | MultiPoint | MultiLineString | MultiPolygon>, properties?: P, options?: {
-    bbox?: BBox;
-    id?: Id;
-}): Feature<GeometryCollection, P>;
-/**
- * Round number to precision
- *
- * @param {number} num Number
- * @param {number} [precision=0] Precision
- * @returns {number} rounded number
- * @example
- * turf.round(120.4321)
- * //=120
- *
- * turf.round(120.4321, 2)
- * //=120.43
- */
-export declare function round(num: number, precision?: number): number;
-/**
- * Convert a distance measurement (assuming a spherical Earth) from radians to a more friendly unit.
- * Valid units: miles, nauticalmiles, inches, yards, meters, metres, kilometers, centimeters, feet
- *
- * @name radiansToLength
- * @param {number} radians in radians across the sphere
- * @param {string} [units="kilometers"] can be degrees, radians, miles, or kilometers inches, yards, metres,
- * meters, kilometres, kilometers.
- * @returns {number} distance
- */
-export declare function radiansToLength(radians: number, units?: Units): number;
-/**
- * Convert a distance measurement (assuming a spherical Earth) from a real-world unit into radians
- * Valid units: miles, nauticalmiles, inches, yards, meters, metres, kilometers, centimeters, feet
- *
- * @name lengthToRadians
- * @param {number} distance in real units
- * @param {string} [units="kilometers"] can be degrees, radians, miles, or kilometers inches, yards, metres,
- * meters, kilometres, kilometers.
- * @returns {number} radians
- */
-export declare function lengthToRadians(distance: number, units?: Units): number;
-/**
- * Convert a distance measurement (assuming a spherical Earth) from a real-world unit into degrees
- * Valid units: miles, nauticalmiles, inches, yards, meters, metres, centimeters, kilometres, feet
- *
- * @name lengthToDegrees
- * @param {number} distance in real units
- * @param {string} [units="kilometers"] can be degrees, radians, miles, or kilometers inches, yards, metres,
- * meters, kilometres, kilometers.
- * @returns {number} degrees
- */
-export declare function lengthToDegrees(distance: number, units?: Units): number;
-/**
- * Converts any bearing angle from the north line direction (positive clockwise)
- * and returns an angle between 0-360 degrees (positive clockwise), 0 being the north line
- *
- * @name bearingToAzimuth
- * @param {number} bearing angle, between -180 and +180 degrees
- * @returns {number} angle between 0 and 360 degrees
- */
-export declare function bearingToAzimuth(bearing: number): number;
-/**
- * Converts an angle in radians to degrees
- *
- * @name radiansToDegrees
- * @param {number} radians angle in radians
- * @returns {number} degrees between 0 and 360 degrees
- */
-export declare function radiansToDegrees(radians: number): number;
-/**
- * Converts an angle in degrees to radians
- *
- * @name degreesToRadians
- * @param {number} degrees angle between 0 and 360 degrees
- * @returns {number} angle in radians
- */
-export declare function degreesToRadians(degrees: number): number;
-/**
- * Converts a length to the requested unit.
- * Valid units: miles, nauticalmiles, inches, yards, meters, metres, kilometers, centimeters, feet
- *
- * @param {number} length to be converted
- * @param {Units} [originalUnit="kilometers"] of the length
- * @param {Units} [finalUnit="kilometers"] returned unit
- * @returns {number} the converted length
- */
-export declare function convertLength(length: number, originalUnit?: Units, finalUnit?: Units): number;
-/**
- * Converts a area to the requested unit.
- * Valid units: kilometers, kilometres, meters, metres, centimetres, millimeters, acres, miles, yards, feet, inches
- * @param {number} area to be converted
- * @param {Units} [originalUnit="meters"] of the distance
- * @param {Units} [finalUnit="kilometers"] returned unit
- * @returns {number} the converted distance
- */
-export declare function convertArea(area: number, originalUnit?: Units, finalUnit?: Units): number;
-/**
- * isNumber
- *
- * @param {*} num Number to validate
- * @returns {boolean} true/false
- * @example
- * turf.isNumber(123)
- * //=true
- * turf.isNumber('foo')
- * //=false
- */
-export declare function isNumber(num: any): boolean;
-/**
- * isObject
- *
- * @param {*} input variable to validate
- * @returns {boolean} true/false
- * @example
- * turf.isObject({elevation: 10})
- * //=true
- * turf.isObject('foo')
- * //=false
- */
-export declare function isObject(input: any): boolean;
-/**
- * Validate BBox
- *
- * @private
- * @param {Array<number>} bbox BBox to validate
- * @returns {void}
- * @throws Error if BBox is not valid
- * @example
- * validateBBox([-180, -40, 110, 50])
- * //=OK
- * validateBBox([-180, -40])
- * //=Error
- * validateBBox('Foo')
- * //=Error
- * validateBBox(5)
- * //=Error
- * validateBBox(null)
- * //=Error
- * validateBBox(undefined)
- * //=Error
- */
-export declare function validateBBox(bbox: any): void;
-/**
- * Validate Id
- *
- * @private
- * @param {string|number} id Id to validate
- * @returns {void}
- * @throws Error if Id is not valid
- * @example
- * validateId([-180, -40, 110, 50])
- * //=Error
- * validateId([-180, -40])
- * //=Error
- * validateId('Foo')
- * //=OK
- * validateId(5)
- * //=OK
- * validateId(null)
- * //=Error
- * validateId(undefined)
- * //=Error
- */
-export declare function validateId(id: any): void;
-export declare function radians2degrees(): void;
-export declare function degrees2radians(): void;
-export declare function distanceToDegrees(): void;
-export declare function distanceToRadians(): void;
-export declare function radiansToDistance(): void;
-export declare function bearingToAngle(): void;
-export declare function convertDistance(): void;

package/dist/es/lib/geojson.d.ts

@@ -1,193 +0,0 @@
-/**
- * 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.
- */
-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>>;
-}