@turf/helpers 7.0.0-alpha.0 → 7.0.0-alpha.110

package/dist/{js → cjs}/index.d.ts

@@ -1,12 +1,52 @@
-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" | "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;
-export declare type AllGeoJSON = Feature | FeatureCollection | Geometry | GeometryCollection;
+import { GeoJSON, Feature, Point, Position, LineString, MultiLineString, Polygon, MultiPolygon, FeatureCollection, Geometry, GeometryCollection, GeometryObject, GeoJsonProperties, BBox, MultiPoint } from 'geojson';
+
+/**
+ * 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.
+ *
+ * Should be contributed to @types/geojson
+ */
+type Id = string | number;
+
+/**
+
+ * GeoJSON equality checking utility.
+ * Adapted from https://github.com/geosquare/geojson-equality
+ *
+ * @memberof helpers
+ * @type {Class}
+ */
+declare class GeojsonEquality {
+    private precision;
+    private direction;
+    private compareProperties;
+    constructor(opts?: {
+        precision?: number;
+        direction?: boolean;
+        compareProperties?: boolean;
+    });
+    compare(g1: GeoJSON, g2: GeoJSON): boolean;
+    private compareCoord;
+    private compareLine;
+    private fixStartIndex;
+    private comparePath;
+    private comparePolygon;
+    private compareGeometryCollection;
+    private compareFeature;
+    private compareFeatureCollection;
+    private compareBBox;
+}
+
+type Coord = Feature<Point> | Point | Position;
+type Units = "meters" | "metres" | "millimeters" | "millimetres" | "centimeters" | "centimetres" | "kilometers" | "kilometres" | "miles" | "nauticalmiles" | "inches" | "yards" | "feet" | "radians" | "degrees";
+type AreaUnits = Exclude<Units, "radians" | "degrees"> | "acres" | "hectares";
+type Grid = "point" | "square" | "hex" | "triangle";
+type Corners = "sw" | "se" | "nw" | "ne" | "center" | "centroid";
+type Lines = LineString | MultiLineString | Polygon | MultiPolygon;
+type AllGeoJSON = Feature | FeatureCollection | Geometry | GeometryCollection;
 /**
  * @module helpers
  */
@@ -16,7 +56,7 @@ export declare type AllGeoJSON = Feature | FeatureCollection | Geometry | Geomet
  * @memberof helpers
  * @type {number}
  */
-export declare const earthRadius = 6371008.8;
+declare const earthRadius = 6371008.8;
 /**
  * Unit of measurement factors using a spherical (non-ellipsoid) earth radius.
  *
@@ -25,9 +65,7 @@ export declare const earthRadius = 6371008.8;
  * @memberof helpers
  * @type {Object}
  */
-export declare const factors: {
-    [key: string]: number;
-};
+declare const factors: Record<Units, number>;
 /**
 
  * Area of measurement factors based on 1 square meter.
@@ -35,9 +73,7 @@ export declare const factors: {
  * @memberof helpers
  * @type {Object}
  */
-export declare const areaFactors: {
-    [key: string]: number;
-};
+declare const areaFactors: Record<AreaUnits, number>;
 /**
  * Wraps a GeoJSON {@link Geometry} in a GeoJSON {@link Feature}.
  *
@@ -58,7 +94,7 @@ export declare const areaFactors: {
  *
  * //=feature
  */
-export declare function feature<G extends GeometryObject = Geometry, P = GeoJsonProperties>(geom: G | null, properties?: P, options?: {
+declare function feature<G extends GeometryObject = Geometry, P extends GeoJsonProperties = GeoJsonProperties>(geom: G | null, properties?: P, options?: {
     bbox?: BBox;
     id?: Id;
 }): Feature<G, P>;
@@ -77,7 +113,7 @@ export declare function feature<G extends GeometryObject = Geometry, P = GeoJson
  * var geometry = turf.geometry(type, coordinates);
  * // => geometry
  */
-export declare function geometry(type: "Point" | "LineString" | "Polygon" | "MultiPoint" | "MultiLineString" | "MultiPolygon", coordinates: any[], _options?: Record<string, never>): Point | MultiPoint | LineString | MultiLineString | Polygon | MultiPolygon;
+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.
  *
@@ -93,7 +129,7 @@ export declare function geometry(type: "Point" | "LineString" | "Polygon" | "Mul
  *
  * //=point
  */
-export declare function point<P = GeoJsonProperties>(coordinates: Position, properties?: P, options?: {
+declare function point<P extends GeoJsonProperties = GeoJsonProperties>(coordinates: Position, properties?: P, options?: {
     bbox?: BBox;
     id?: Id;
 }): Feature<Point, P>;
@@ -117,7 +153,7 @@ export declare function point<P = GeoJsonProperties>(coordinates: Position, prop
  *
  * //=points
  */
-export declare function points<P = GeoJsonProperties>(coordinates: Position[], properties?: P, options?: {
+declare function points<P extends GeoJsonProperties = GeoJsonProperties>(coordinates: Position[], properties?: P, options?: {
     bbox?: BBox;
     id?: Id;
 }): FeatureCollection<Point, P>;
@@ -136,7 +172,7 @@ export declare function points<P = GeoJsonProperties>(coordinates: Position[], p
  *
  * //=polygon
  */
-export declare function polygon<P = GeoJsonProperties>(coordinates: Position[][], properties?: P, options?: {
+declare function polygon<P extends GeoJsonProperties = GeoJsonProperties>(coordinates: Position[][], properties?: P, options?: {
     bbox?: BBox;
     id?: Id;
 }): Feature<Polygon, P>;
@@ -158,7 +194,7 @@ export declare function polygon<P = GeoJsonProperties>(coordinates: Position[][]
  *
  * //=polygons
  */
-export declare function polygons<P = GeoJsonProperties>(coordinates: Position[][][], properties?: P, options?: {
+declare function polygons<P extends GeoJsonProperties = GeoJsonProperties>(coordinates: Position[][][], properties?: P, options?: {
     bbox?: BBox;
     id?: Id;
 }): FeatureCollection<Polygon, P>;
@@ -179,7 +215,7 @@ export declare function polygons<P = GeoJsonProperties>(coordinates: Position[][
  * //=linestring1
  * //=linestring2
  */
-export declare function lineString<P = GeoJsonProperties>(coordinates: Position[], properties?: P, options?: {
+declare function lineString<P extends GeoJsonProperties = GeoJsonProperties>(coordinates: Position[], properties?: P, options?: {
     bbox?: BBox;
     id?: Id;
 }): Feature<LineString, P>;
@@ -202,7 +238,7 @@ export declare function lineString<P = GeoJsonProperties>(coordinates: Position[
  *
  * //=linestrings
  */
-export declare function lineStrings<P = GeoJsonProperties>(coordinates: Position[][], properties?: P, options?: {
+declare function lineStrings<P extends GeoJsonProperties = GeoJsonProperties>(coordinates: Position[][], properties?: P, options?: {
     bbox?: BBox;
     id?: Id;
 }): FeatureCollection<LineString, P>;
@@ -228,7 +264,7 @@ export declare function lineStrings<P = GeoJsonProperties>(coordinates: Position
  *
  * //=collection
  */
-export declare function featureCollection<G extends GeometryObject = Geometry, P = GeoJsonProperties>(features: Array<Feature<G, P>>, options?: {
+declare function featureCollection<G extends GeometryObject = Geometry, P extends GeoJsonProperties = GeoJsonProperties>(features: Array<Feature<G, P>>, options?: {
     bbox?: BBox;
     id?: Id;
 }): FeatureCollection<G, P>;
@@ -249,7 +285,7 @@ export declare function featureCollection<G extends GeometryObject = Geometry, P
  *
  * //=multiLine
  */
-export declare function multiLineString<P = GeoJsonProperties>(coordinates: Position[][], properties?: P, options?: {
+declare function multiLineString<P extends GeoJsonProperties = GeoJsonProperties>(coordinates: Position[][], properties?: P, options?: {
     bbox?: BBox;
     id?: Id;
 }): Feature<MultiLineString, P>;
@@ -270,7 +306,7 @@ export declare function multiLineString<P = GeoJsonProperties>(coordinates: Posi
  *
  * //=multiPt
  */
-export declare function multiPoint<P = GeoJsonProperties>(coordinates: Position[], properties?: P, options?: {
+declare function multiPoint<P extends GeoJsonProperties = GeoJsonProperties>(coordinates: Position[], properties?: P, options?: {
     bbox?: BBox;
     id?: Id;
 }): Feature<MultiPoint, P>;
@@ -292,7 +328,7 @@ export declare function multiPoint<P = GeoJsonProperties>(coordinates: Position[
  * //=multiPoly
  *
  */
-export declare function multiPolygon<P = GeoJsonProperties>(coordinates: Position[][][], properties?: P, options?: {
+declare function multiPolygon<P extends GeoJsonProperties = GeoJsonProperties>(coordinates: Position[][][], properties?: P, options?: {
     bbox?: BBox;
     id?: Id;
 }): Feature<MultiPolygon, P>;
@@ -314,7 +350,7 @@ export declare function multiPolygon<P = GeoJsonProperties>(coordinates: Positio
  *
  * // => collection
  */
-export declare function geometryCollection<P = GeoJsonProperties>(geometries: Array<Point | LineString | Polygon | MultiPoint | MultiLineString | MultiPolygon>, properties?: P, options?: {
+declare function geometryCollection<P extends GeoJsonProperties = GeoJsonProperties>(geometries: Array<Point | LineString | Polygon | MultiPoint | MultiLineString | MultiPolygon>, properties?: P, options?: {
     bbox?: BBox;
     id?: Id;
 }): Feature<GeometryCollection, P>;
@@ -331,7 +367,7 @@ export declare function geometryCollection<P = GeoJsonProperties>(geometries: Ar
  * turf.round(120.4321, 2)
  * //=120.43
  */
-export declare function round(num: number, precision?: number): number;
+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
@@ -342,7 +378,7 @@ export declare function round(num: number, precision?: number): number;
  * meters, kilometres, kilometers.
  * @returns {number} distance
  */
-export declare function radiansToLength(radians: number, units?: Units): number;
+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
@@ -353,7 +389,7 @@ export declare function radiansToLength(radians: number, units?: Units): number;
  * meters, kilometres, kilometers.
  * @returns {number} radians
  */
-export declare function lengthToRadians(distance: number, units?: Units): number;
+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
@@ -364,7 +400,7 @@ export declare function lengthToRadians(distance: number, units?: Units): number
  * meters, kilometres, kilometers.
  * @returns {number} degrees
  */
-export declare function lengthToDegrees(distance: number, units?: Units): number;
+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
@@ -373,7 +409,7 @@ export declare function lengthToDegrees(distance: number, units?: Units): number
  * @param {number} bearing angle, between -180 and +180 degrees
  * @returns {number} angle between 0 and 360 degrees
  */
-export declare function bearingToAzimuth(bearing: number): number;
+declare function bearingToAzimuth(bearing: number): number;
 /**
  * Converts an angle in radians to degrees
  *
@@ -381,7 +417,7 @@ export declare function bearingToAzimuth(bearing: number): number;
  * @param {number} radians angle in radians
  * @returns {number} degrees between 0 and 360 degrees
  */
-export declare function radiansToDegrees(radians: number): number;
+declare function radiansToDegrees(radians: number): number;
 /**
  * Converts an angle in degrees to radians
  *
@@ -389,7 +425,7 @@ export declare function radiansToDegrees(radians: number): number;
  * @param {number} degrees angle between 0 and 360 degrees
  * @returns {number} angle in radians
  */
-export declare function degreesToRadians(degrees: number): number;
+declare function degreesToRadians(degrees: number): number;
 /**
  * Converts a length to the requested unit.
  * Valid units: miles, nauticalmiles, inches, yards, meters, metres, kilometers, centimeters, feet
@@ -399,7 +435,7 @@ export declare function degreesToRadians(degrees: number): number;
  * @param {Units} [finalUnit="kilometers"] returned unit
  * @returns {number} the converted length
  */
-export declare function convertLength(length: number, originalUnit?: Units, finalUnit?: Units): number;
+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, hectares
@@ -408,7 +444,7 @@ export declare function convertLength(length: number, originalUnit?: Units, fina
  * @param {Units} [finalUnit="kilometers"] returned unit
  * @returns {number} the converted area
  */
-export declare function convertArea(area: number, originalUnit?: Units, finalUnit?: Units): number;
+declare function convertArea(area: number, originalUnit?: AreaUnits, finalUnit?: AreaUnits): number;
 /**
  * isNumber
  *
@@ -420,7 +456,7 @@ export declare function convertArea(area: number, originalUnit?: Units, finalUni
  * turf.isNumber('foo')
  * //=false
  */
-export declare function isNumber(num: any): boolean;
+declare function isNumber(num: any): boolean;
 /**
  * isObject
  *
@@ -432,7 +468,7 @@ export declare function isNumber(num: any): boolean;
  * turf.isObject('foo')
  * //=false
  */
-export declare function isObject(input: any): boolean;
+declare function isObject(input: any): boolean;
 /**
  * Validate BBox
  *
@@ -454,7 +490,7 @@ export declare function isObject(input: any): boolean;
  * validateBBox(undefined)
  * //=Error
  */
-export declare function validateBBox(bbox: any): void;
+declare function validateBBox(bbox: any): void;
 /**
  * Validate Id
  *
@@ -476,4 +512,6 @@ export declare function validateBBox(bbox: any): void;
  * validateId(undefined)
  * //=Error
  */
-export declare function validateId(id: any): void;
+declare function validateId(id: any): void;
+
+export { type AllGeoJSON, type AreaUnits, type Coord, type Corners, GeojsonEquality, type Grid, type Id, type Lines, type Units, areaFactors, bearingToAzimuth, convertArea, convertLength, degreesToRadians, earthRadius, factors, feature, featureCollection, geometry, geometryCollection, isNumber, isObject, lengthToDegrees, lengthToRadians, lineString, lineStrings, multiLineString, multiPoint, multiPolygon, point, points, polygon, polygons, radiansToDegrees, radiansToLength, round, validateBBox, validateId };