@turf/sector 7.1.0 → 7.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/index.cjs +4 -8
- package/dist/cjs/index.cjs.map +1 -1
- package/dist/cjs/index.d.cts +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +4 -8
- package/dist/esm/index.js.map +1 -1
- package/package.json +14 -14
package/dist/cjs/index.cjs
CHANGED
|
@@ -6,19 +6,15 @@ var _helpers = require('@turf/helpers');
|
|
|
6
6
|
var _invariant = require('@turf/invariant');
|
|
7
7
|
function sector(center, radius, bearing1, bearing2, options = {}) {
|
|
8
8
|
options = options || {};
|
|
9
|
-
if (!_helpers.isObject.call(void 0, options))
|
|
10
|
-
throw new Error("options is invalid");
|
|
9
|
+
if (!_helpers.isObject.call(void 0, options)) throw new Error("options is invalid");
|
|
11
10
|
const properties = options.properties;
|
|
12
|
-
if (!center)
|
|
13
|
-
throw new Error("center is required");
|
|
11
|
+
if (!center) throw new Error("center is required");
|
|
14
12
|
if (bearing1 === void 0 || bearing1 === null)
|
|
15
13
|
throw new Error("bearing1 is required");
|
|
16
14
|
if (bearing2 === void 0 || bearing2 === null)
|
|
17
15
|
throw new Error("bearing2 is required");
|
|
18
|
-
if (!radius)
|
|
19
|
-
|
|
20
|
-
if (typeof options !== "object")
|
|
21
|
-
throw new Error("options must be an object");
|
|
16
|
+
if (!radius) throw new Error("radius is required");
|
|
17
|
+
if (typeof options !== "object") throw new Error("options must be an object");
|
|
22
18
|
if (convertAngleTo360(bearing1) === convertAngleTo360(bearing2)) {
|
|
23
19
|
return _circle.circle.call(void 0, center, radius, options);
|
|
24
20
|
}
|
package/dist/cjs/index.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../index.ts"],"names":[],"mappings":";
|
|
1
|
+
{"version":3,"sources":["/home/runner/work/turf/turf/packages/turf-sector/dist/cjs/index.cjs","../../index.ts"],"names":[],"mappings":"AAAA;ACCA,sCAAuB;AACvB,yCAAwB;AACxB,kCAA0B;AAC1B,wCAAgD;AAChD,4CAA0B;AA2B1B,SAAS,MAAA,CACP,MAAA,EACA,MAAA,EACA,QAAA,EACA,QAAA,EACA,QAAA,EAII,CAAC,CAAA,EACa;AAElB,EAAA,QAAA,EAAU,QAAA,GAAW,CAAC,CAAA;AACtB,EAAA,GAAA,CAAI,CAAC,+BAAA,OAAgB,CAAA,EAAG,MAAM,IAAI,KAAA,CAAM,oBAAoB,CAAA;AAE5D,EAAA,MAAM,WAAA,EAAa,OAAA,CAAQ,UAAA;AAG3B,EAAA,GAAA,CAAI,CAAC,MAAA,EAAQ,MAAM,IAAI,KAAA,CAAM,oBAAoB,CAAA;AACjD,EAAA,GAAA,CAAI,SAAA,IAAa,KAAA,EAAA,GAAa,SAAA,IAAa,IAAA;AACzC,IAAA,MAAM,IAAI,KAAA,CAAM,sBAAsB,CAAA;AACxC,EAAA,GAAA,CAAI,SAAA,IAAa,KAAA,EAAA,GAAa,SAAA,IAAa,IAAA;AACzC,IAAA,MAAM,IAAI,KAAA,CAAM,sBAAsB,CAAA;AACxC,EAAA,GAAA,CAAI,CAAC,MAAA,EAAQ,MAAM,IAAI,KAAA,CAAM,oBAAoB,CAAA;AACjD,EAAA,GAAA,CAAI,OAAO,QAAA,IAAY,QAAA,EAAU,MAAM,IAAI,KAAA,CAAM,2BAA2B,CAAA;AAE5E,EAAA,GAAA,CAAI,iBAAA,CAAkB,QAAQ,EAAA,IAAM,iBAAA,CAAkB,QAAQ,CAAA,EAAG;AAC/D,IAAA,OAAO,4BAAA,MAAO,EAAQ,MAAA,EAAQ,OAAO,CAAA;AAAA,EACvC;AACA,EAAA,MAAM,OAAA,EAAS,kCAAA,MAAgB,CAAA;AAC/B,EAAA,MAAM,IAAA,EAAM,8BAAA,MAAQ,EAAQ,MAAA,EAAQ,QAAA,EAAU,QAAA,EAAU,OAAO,CAAA;AAC/D,EAAA,MAAM,YAAA,EAAc,CAAC,CAAC,MAAM,CAAC,CAAA;AAC7B,EAAA,6BAAA,GAAU,EAAK,QAAA,CAAU,aAAA,EAAe;AACtC,IAAA,WAAA,CAAY,CAAC,CAAA,CAAE,IAAA,CAAK,aAAa,CAAA;AAAA,EACnC,CAAC,CAAA;AACD,EAAA,WAAA,CAAY,CAAC,CAAA,CAAE,IAAA,CAAK,MAAM,CAAA;AAE1B,EAAA,OAAO,8BAAA,WAAQ,EAAa,UAAU,CAAA;AACxC;AAUA,SAAS,iBAAA,CAAkB,KAAA,EAAe;AACxC,EAAA,IAAI,KAAA,EAAO,MAAA,EAAQ,GAAA;AACnB,EAAA,GAAA,CAAI,KAAA,EAAO,CAAA,EAAG;AACZ,IAAA,KAAA,GAAQ,GAAA;AAAA,EACV;AACA,EAAA,OAAO,IAAA;AACT;AAGA,IAAO,oBAAA,EAAQ,MAAA;ADpDf;AACE;AACA;AACF,+DAAC","file":"/home/runner/work/turf/turf/packages/turf-sector/dist/cjs/index.cjs","sourcesContent":[null,"import { Feature, Polygon, GeoJsonProperties } from \"geojson\";\nimport { circle } from \"@turf/circle\";\nimport { lineArc } from \"@turf/line-arc\";\nimport { coordEach } from \"@turf/meta\";\nimport { Units, Coord, isObject, polygon } from \"@turf/helpers\";\nimport { getCoords } from \"@turf/invariant\";\n\n/**\n * Creates a circular sector of a circle of given radius and center {@link Point},\n * between (clockwise) bearing1 and bearing2; 0 bearing is North of center point, positive clockwise.\n *\n * @function\n * @param {Coord} center center point\n * @param {number} radius radius of the circle\n * @param {number} bearing1 angle, in decimal degrees, of the first radius of the sector\n * @param {number} bearing2 angle, in decimal degrees, of the second radius of the sector\n * @param {Object} [options={}] Optional parameters\n * @param {string} [options.units='kilometers'] miles, kilometers, degrees, or radians\n * @param {number} [options.steps=64] number of steps\n * @param {Properties} [options.properties={}] Translate properties to Feature Polygon\n * @returns {Feature<Polygon>} sector polygon\n * @example\n * var center = turf.point([-75, 40]);\n * var radius = 5;\n * var bearing1 = 25;\n * var bearing2 = 45;\n *\n * var sector = turf.sector(center, radius, bearing1, bearing2);\n *\n * //addToMap\n * var addToMap = [center, sector];\n */\nfunction sector(\n center: Coord,\n radius: number,\n bearing1: number,\n bearing2: number,\n options: {\n steps?: number;\n units?: Units;\n properties?: GeoJsonProperties;\n } = {}\n): Feature<Polygon> {\n // Optional parameters\n options = options || {};\n if (!isObject(options)) throw new Error(\"options is invalid\");\n // Most options only for passing through to circle()\n const properties = options.properties;\n\n // validation\n if (!center) throw new Error(\"center is required\");\n if (bearing1 === undefined || bearing1 === null)\n throw new Error(\"bearing1 is required\");\n if (bearing2 === undefined || bearing2 === null)\n throw new Error(\"bearing2 is required\");\n if (!radius) throw new Error(\"radius is required\");\n if (typeof options !== \"object\") throw new Error(\"options must be an object\");\n\n if (convertAngleTo360(bearing1) === convertAngleTo360(bearing2)) {\n return circle(center, radius, options);\n }\n const coords = getCoords(center);\n const arc = lineArc(center, radius, bearing1, bearing2, options);\n const sliceCoords = [[coords]];\n coordEach(arc, function (currentCoords) {\n sliceCoords[0].push(currentCoords);\n });\n sliceCoords[0].push(coords);\n\n return polygon(sliceCoords, properties);\n}\n\n/**\n * Takes any angle in degrees\n * and returns a valid angle between 0-360 degrees\n *\n * @private\n * @param {number} alpha angle between -180-180 degrees\n * @returns {number} angle between 0-360 degrees\n */\nfunction convertAngleTo360(alpha: number) {\n let beta = alpha % 360;\n if (beta < 0) {\n beta += 360;\n }\n return beta;\n}\n\nexport { sector };\nexport default sector;\n"]}
|
package/dist/cjs/index.d.cts
CHANGED
|
@@ -5,7 +5,7 @@ import { Coord, Units } from '@turf/helpers';
|
|
|
5
5
|
* Creates a circular sector of a circle of given radius and center {@link Point},
|
|
6
6
|
* between (clockwise) bearing1 and bearing2; 0 bearing is North of center point, positive clockwise.
|
|
7
7
|
*
|
|
8
|
-
* @
|
|
8
|
+
* @function
|
|
9
9
|
* @param {Coord} center center point
|
|
10
10
|
* @param {number} radius radius of the circle
|
|
11
11
|
* @param {number} bearing1 angle, in decimal degrees, of the first radius of the sector
|
package/dist/esm/index.d.ts
CHANGED
|
@@ -5,7 +5,7 @@ import { Coord, Units } from '@turf/helpers';
|
|
|
5
5
|
* Creates a circular sector of a circle of given radius and center {@link Point},
|
|
6
6
|
* between (clockwise) bearing1 and bearing2; 0 bearing is North of center point, positive clockwise.
|
|
7
7
|
*
|
|
8
|
-
* @
|
|
8
|
+
* @function
|
|
9
9
|
* @param {Coord} center center point
|
|
10
10
|
* @param {number} radius radius of the circle
|
|
11
11
|
* @param {number} bearing1 angle, in decimal degrees, of the first radius of the sector
|
package/dist/esm/index.js
CHANGED
|
@@ -6,19 +6,15 @@ import { isObject, polygon } from "@turf/helpers";
|
|
|
6
6
|
import { getCoords } from "@turf/invariant";
|
|
7
7
|
function sector(center, radius, bearing1, bearing2, options = {}) {
|
|
8
8
|
options = options || {};
|
|
9
|
-
if (!isObject(options))
|
|
10
|
-
throw new Error("options is invalid");
|
|
9
|
+
if (!isObject(options)) throw new Error("options is invalid");
|
|
11
10
|
const properties = options.properties;
|
|
12
|
-
if (!center)
|
|
13
|
-
throw new Error("center is required");
|
|
11
|
+
if (!center) throw new Error("center is required");
|
|
14
12
|
if (bearing1 === void 0 || bearing1 === null)
|
|
15
13
|
throw new Error("bearing1 is required");
|
|
16
14
|
if (bearing2 === void 0 || bearing2 === null)
|
|
17
15
|
throw new Error("bearing2 is required");
|
|
18
|
-
if (!radius)
|
|
19
|
-
|
|
20
|
-
if (typeof options !== "object")
|
|
21
|
-
throw new Error("options must be an object");
|
|
16
|
+
if (!radius) throw new Error("radius is required");
|
|
17
|
+
if (typeof options !== "object") throw new Error("options must be an object");
|
|
22
18
|
if (convertAngleTo360(bearing1) === convertAngleTo360(bearing2)) {
|
|
23
19
|
return circle(center, radius, options);
|
|
24
20
|
}
|
package/dist/esm/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../index.ts"],"sourcesContent":["import { Feature, Polygon, GeoJsonProperties } from \"geojson\";\nimport { circle } from \"@turf/circle\";\nimport { lineArc } from \"@turf/line-arc\";\nimport { coordEach } from \"@turf/meta\";\nimport { Units, Coord, isObject, polygon } from \"@turf/helpers\";\nimport { getCoords } from \"@turf/invariant\";\n\n/**\n * Creates a circular sector of a circle of given radius and center {@link Point},\n * between (clockwise) bearing1 and bearing2; 0 bearing is North of center point, positive clockwise.\n *\n * @
|
|
1
|
+
{"version":3,"sources":["../../index.ts"],"sourcesContent":["import { Feature, Polygon, GeoJsonProperties } from \"geojson\";\nimport { circle } from \"@turf/circle\";\nimport { lineArc } from \"@turf/line-arc\";\nimport { coordEach } from \"@turf/meta\";\nimport { Units, Coord, isObject, polygon } from \"@turf/helpers\";\nimport { getCoords } from \"@turf/invariant\";\n\n/**\n * Creates a circular sector of a circle of given radius and center {@link Point},\n * between (clockwise) bearing1 and bearing2; 0 bearing is North of center point, positive clockwise.\n *\n * @function\n * @param {Coord} center center point\n * @param {number} radius radius of the circle\n * @param {number} bearing1 angle, in decimal degrees, of the first radius of the sector\n * @param {number} bearing2 angle, in decimal degrees, of the second radius of the sector\n * @param {Object} [options={}] Optional parameters\n * @param {string} [options.units='kilometers'] miles, kilometers, degrees, or radians\n * @param {number} [options.steps=64] number of steps\n * @param {Properties} [options.properties={}] Translate properties to Feature Polygon\n * @returns {Feature<Polygon>} sector polygon\n * @example\n * var center = turf.point([-75, 40]);\n * var radius = 5;\n * var bearing1 = 25;\n * var bearing2 = 45;\n *\n * var sector = turf.sector(center, radius, bearing1, bearing2);\n *\n * //addToMap\n * var addToMap = [center, sector];\n */\nfunction sector(\n center: Coord,\n radius: number,\n bearing1: number,\n bearing2: number,\n options: {\n steps?: number;\n units?: Units;\n properties?: GeoJsonProperties;\n } = {}\n): Feature<Polygon> {\n // Optional parameters\n options = options || {};\n if (!isObject(options)) throw new Error(\"options is invalid\");\n // Most options only for passing through to circle()\n const properties = options.properties;\n\n // validation\n if (!center) throw new Error(\"center is required\");\n if (bearing1 === undefined || bearing1 === null)\n throw new Error(\"bearing1 is required\");\n if (bearing2 === undefined || bearing2 === null)\n throw new Error(\"bearing2 is required\");\n if (!radius) throw new Error(\"radius is required\");\n if (typeof options !== \"object\") throw new Error(\"options must be an object\");\n\n if (convertAngleTo360(bearing1) === convertAngleTo360(bearing2)) {\n return circle(center, radius, options);\n }\n const coords = getCoords(center);\n const arc = lineArc(center, radius, bearing1, bearing2, options);\n const sliceCoords = [[coords]];\n coordEach(arc, function (currentCoords) {\n sliceCoords[0].push(currentCoords);\n });\n sliceCoords[0].push(coords);\n\n return polygon(sliceCoords, properties);\n}\n\n/**\n * Takes any angle in degrees\n * and returns a valid angle between 0-360 degrees\n *\n * @private\n * @param {number} alpha angle between -180-180 degrees\n * @returns {number} angle between 0-360 degrees\n */\nfunction convertAngleTo360(alpha: number) {\n let beta = alpha % 360;\n if (beta < 0) {\n beta += 360;\n }\n return beta;\n}\n\nexport { sector };\nexport default sector;\n"],"mappings":";AACA,SAAS,cAAc;AACvB,SAAS,eAAe;AACxB,SAAS,iBAAiB;AAC1B,SAAuB,UAAU,eAAe;AAChD,SAAS,iBAAiB;AA2B1B,SAAS,OACP,QACA,QACA,UACA,UACA,UAII,CAAC,GACa;AAElB,YAAU,WAAW,CAAC;AACtB,MAAI,CAAC,SAAS,OAAO,EAAG,OAAM,IAAI,MAAM,oBAAoB;AAE5D,QAAM,aAAa,QAAQ;AAG3B,MAAI,CAAC,OAAQ,OAAM,IAAI,MAAM,oBAAoB;AACjD,MAAI,aAAa,UAAa,aAAa;AACzC,UAAM,IAAI,MAAM,sBAAsB;AACxC,MAAI,aAAa,UAAa,aAAa;AACzC,UAAM,IAAI,MAAM,sBAAsB;AACxC,MAAI,CAAC,OAAQ,OAAM,IAAI,MAAM,oBAAoB;AACjD,MAAI,OAAO,YAAY,SAAU,OAAM,IAAI,MAAM,2BAA2B;AAE5E,MAAI,kBAAkB,QAAQ,MAAM,kBAAkB,QAAQ,GAAG;AAC/D,WAAO,OAAO,QAAQ,QAAQ,OAAO;AAAA,EACvC;AACA,QAAM,SAAS,UAAU,MAAM;AAC/B,QAAM,MAAM,QAAQ,QAAQ,QAAQ,UAAU,UAAU,OAAO;AAC/D,QAAM,cAAc,CAAC,CAAC,MAAM,CAAC;AAC7B,YAAU,KAAK,SAAU,eAAe;AACtC,gBAAY,CAAC,EAAE,KAAK,aAAa;AAAA,EACnC,CAAC;AACD,cAAY,CAAC,EAAE,KAAK,MAAM;AAE1B,SAAO,QAAQ,aAAa,UAAU;AACxC;AAUA,SAAS,kBAAkB,OAAe;AACxC,MAAI,OAAO,QAAQ;AACnB,MAAI,OAAO,GAAG;AACZ,YAAQ;AAAA,EACV;AACA,SAAO;AACT;AAGA,IAAO,sBAAQ;","names":[]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@turf/sector",
|
|
3
|
-
"version": "7.
|
|
3
|
+
"version": "7.2.0",
|
|
4
4
|
"description": "turf sector module",
|
|
5
5
|
"author": "Turf Authors",
|
|
6
6
|
"license": "MIT",
|
|
@@ -50,26 +50,26 @@
|
|
|
50
50
|
"test:types": "tsc --esModuleInterop --module node16 --moduleResolution node16 --noEmit --strict types.ts"
|
|
51
51
|
},
|
|
52
52
|
"devDependencies": {
|
|
53
|
-
"@turf/truncate": "^7.
|
|
53
|
+
"@turf/truncate": "^7.2.0",
|
|
54
54
|
"@types/benchmark": "^2.1.5",
|
|
55
|
-
"@types/tape": "^4.
|
|
55
|
+
"@types/tape": "^4.13.4",
|
|
56
56
|
"benchmark": "^2.1.4",
|
|
57
57
|
"load-json-file": "^7.0.1",
|
|
58
58
|
"npm-run-all": "^4.1.5",
|
|
59
|
-
"tape": "^5.
|
|
60
|
-
"tsup": "^8.
|
|
61
|
-
"tsx": "^4.
|
|
62
|
-
"typescript": "^5.
|
|
59
|
+
"tape": "^5.9.0",
|
|
60
|
+
"tsup": "^8.3.5",
|
|
61
|
+
"tsx": "^4.19.2",
|
|
62
|
+
"typescript": "^5.5.4",
|
|
63
63
|
"write-json-file": "^5.0.0"
|
|
64
64
|
},
|
|
65
65
|
"dependencies": {
|
|
66
|
-
"@turf/circle": "^7.
|
|
67
|
-
"@turf/helpers": "^7.
|
|
68
|
-
"@turf/invariant": "^7.
|
|
69
|
-
"@turf/line-arc": "^7.
|
|
70
|
-
"@turf/meta": "^7.
|
|
66
|
+
"@turf/circle": "^7.2.0",
|
|
67
|
+
"@turf/helpers": "^7.2.0",
|
|
68
|
+
"@turf/invariant": "^7.2.0",
|
|
69
|
+
"@turf/line-arc": "^7.2.0",
|
|
70
|
+
"@turf/meta": "^7.2.0",
|
|
71
71
|
"@types/geojson": "^7946.0.10",
|
|
72
|
-
"tslib": "^2.
|
|
72
|
+
"tslib": "^2.8.1"
|
|
73
73
|
},
|
|
74
|
-
"gitHead": "
|
|
74
|
+
"gitHead": "7b0f0374c4668cd569f8904c71e2ae7d941be867"
|
|
75
75
|
}
|