@turf/line-arc 7.2.0 → 7.3.1
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/README.md +2 -2
- package/dist/cjs/index.cjs +2 -2
- 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 +2 -2
- package/dist/esm/index.js.map +1 -1
- package/package.json +13 -14
package/README.md
CHANGED
|
@@ -16,7 +16,7 @@ Creates a circular arc, of a circle of the given radius and center point, betwee
|
|
|
16
16
|
* `options` **[Object][3]** Optional parameters (optional, default `{}`)
|
|
17
17
|
|
|
18
18
|
* `options.steps` **[number][2]** number of steps (straight segments) that will constitute the arc (optional, default `64`)
|
|
19
|
-
* `options.units` **
|
|
19
|
+
* `options.units` **Units** Supports all valid Turf [Units][4]. (optional, default `'kilometers'`)
|
|
20
20
|
|
|
21
21
|
### Examples
|
|
22
22
|
|
|
@@ -40,7 +40,7 @@ Returns **[Feature][5]<[LineString][6]>** line arc
|
|
|
40
40
|
|
|
41
41
|
[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
|
|
42
42
|
|
|
43
|
-
[4]: https://
|
|
43
|
+
[4]: https://turfjs.org/docs/api/types/Units
|
|
44
44
|
|
|
45
45
|
[5]: https://tools.ietf.org/html/rfc7946#section-3.2
|
|
46
46
|
|
package/dist/cjs/index.cjs
CHANGED
|
@@ -35,9 +35,9 @@ function convertAngleTo360(alpha) {
|
|
|
35
35
|
}
|
|
36
36
|
return beta;
|
|
37
37
|
}
|
|
38
|
-
var
|
|
38
|
+
var index_default = lineArc;
|
|
39
39
|
|
|
40
40
|
|
|
41
41
|
|
|
42
|
-
exports.default =
|
|
42
|
+
exports.default = index_default; exports.lineArc = lineArc;
|
|
43
43
|
//# sourceMappingURL=index.cjs.map
|
package/dist/cjs/index.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["/home/runner/work/turf/turf/packages/turf-line-arc/dist/cjs/index.cjs","../../index.ts"],"names":[],"mappings":"AAAA;ACCA,sCAAuB;AACvB,gDAA4B;AAC5B,wCAAyC;AA0BzC,SAAS,OAAA,CACP,MAAA,EACA,MAAA,EACA,QAAA,EACA,QAAA,EACA,QAAA,EAGI,CAAC,CAAA,EACgB;AAErB,EAAA,MAAM,MAAA,EAAQ,OAAA,CAAQ,MAAA,GAAS,EAAA;AAE/B,EAAA,MAAM,OAAA,EAAS,iBAAA,CAAkB,QAAQ,CAAA;AACzC,EAAA,MAAM,OAAA,EAAS,iBAAA,CAAkB,QAAQ,CAAA;AACzC,EAAA,MAAM,WAAA,EACJ,CAAC,KAAA,CAAM,OAAA,CAAQ,MAAM,EAAA,GAAK,MAAA,CAAO,KAAA,IAAS,UAAA,EACtC,MAAA,CAAO,WAAA,EACP,CAAC,CAAA;AAGP,EAAA,GAAA,CAAI,OAAA,IAAW,MAAA,EAAQ;AACrB,IAAA,OAAO,iCAAA;AAAA,MACL,4BAAA,MAAO,EAAQ,MAAA,EAAQ,OAAO,CAAA,CAAE,QAAA,CAAS,WAAA,CAAY,CAAC,CAAA;AAAA,MACtD;AAAA,IACF,CAAA;AAAA,EACF;AACA,EAAA,MAAM,eAAA,EAAiB,MAAA;AACvB,EAAA,MAAM,aAAA,EAAe,OAAA,EAAS,OAAA,EAAS,OAAA,EAAS,OAAA,EAAS,GAAA;AAEzD,EAAA,IAAI,MAAA,EAAQ,cAAA;AACZ,EAAA,MAAM,YAAA,EAAc,CAAC,CAAA;AACrB,EAAA,IAAI,EAAA,EAAI,CAAA;AAER,EAAA,MAAM,QAAA,EAAA,CAAW,aAAA,EAAe,cAAA,EAAA,EAAkB,KAAA;AAGlD,EAAA,MAAA,CAAO,MAAA,GAAS,YAAA,EAAc;AAC5B,IAAA,WAAA,CAAY,IAAA;AAAA,MACV,sCAAA,MAAY,EAAQ,MAAA,EAAQ,KAAA,EAAO,OAAO,CAAA,CAAE,QAAA,CAAS;AAAA,IACvD,CAAA;AACA,IAAA,CAAA,EAAA;AACA,IAAA,MAAA,EAAQ,eAAA,EAAiB,EAAA,EAAI,OAAA;AAAA,EAC/B;AACA,EAAA,OAAO,iCAAA,WAAW,EAAa,UAAU,CAAA;AAC3C;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,
|
|
1
|
+
{"version":3,"sources":["/home/runner/work/turf/turf/packages/turf-line-arc/dist/cjs/index.cjs","../../index.ts"],"names":[],"mappings":"AAAA;ACCA,sCAAuB;AACvB,gDAA4B;AAC5B,wCAAyC;AA0BzC,SAAS,OAAA,CACP,MAAA,EACA,MAAA,EACA,QAAA,EACA,QAAA,EACA,QAAA,EAGI,CAAC,CAAA,EACgB;AAErB,EAAA,MAAM,MAAA,EAAQ,OAAA,CAAQ,MAAA,GAAS,EAAA;AAE/B,EAAA,MAAM,OAAA,EAAS,iBAAA,CAAkB,QAAQ,CAAA;AACzC,EAAA,MAAM,OAAA,EAAS,iBAAA,CAAkB,QAAQ,CAAA;AACzC,EAAA,MAAM,WAAA,EACJ,CAAC,KAAA,CAAM,OAAA,CAAQ,MAAM,EAAA,GAAK,MAAA,CAAO,KAAA,IAAS,UAAA,EACtC,MAAA,CAAO,WAAA,EACP,CAAC,CAAA;AAGP,EAAA,GAAA,CAAI,OAAA,IAAW,MAAA,EAAQ;AACrB,IAAA,OAAO,iCAAA;AAAA,MACL,4BAAA,MAAO,EAAQ,MAAA,EAAQ,OAAO,CAAA,CAAE,QAAA,CAAS,WAAA,CAAY,CAAC,CAAA;AAAA,MACtD;AAAA,IACF,CAAA;AAAA,EACF;AACA,EAAA,MAAM,eAAA,EAAiB,MAAA;AACvB,EAAA,MAAM,aAAA,EAAe,OAAA,EAAS,OAAA,EAAS,OAAA,EAAS,OAAA,EAAS,GAAA;AAEzD,EAAA,IAAI,MAAA,EAAQ,cAAA;AACZ,EAAA,MAAM,YAAA,EAAc,CAAC,CAAA;AACrB,EAAA,IAAI,EAAA,EAAI,CAAA;AAER,EAAA,MAAM,QAAA,EAAA,CAAW,aAAA,EAAe,cAAA,EAAA,EAAkB,KAAA;AAGlD,EAAA,MAAA,CAAO,MAAA,GAAS,YAAA,EAAc;AAC5B,IAAA,WAAA,CAAY,IAAA;AAAA,MACV,sCAAA,MAAY,EAAQ,MAAA,EAAQ,KAAA,EAAO,OAAO,CAAA,CAAE,QAAA,CAAS;AAAA,IACvD,CAAA;AACA,IAAA,CAAA,EAAA;AACA,IAAA,MAAA,EAAQ,eAAA,EAAiB,EAAA,EAAI,OAAA;AAAA,EAC/B;AACA,EAAA,OAAO,iCAAA,WAAW,EAAa,UAAU,CAAA;AAC3C;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,cAAA,EAAQ,OAAA;ADvDf;AACE;AACA;AACF,2DAAC","file":"/home/runner/work/turf/turf/packages/turf-line-arc/dist/cjs/index.cjs","sourcesContent":[null,"import { Feature, LineString } from \"geojson\";\nimport { circle } from \"@turf/circle\";\nimport { destination } from \"@turf/destination\";\nimport { Coord, lineString, Units } from \"@turf/helpers\";\n\n/**\n * Creates a circular arc, of a circle of the given radius and center point, between bearing1 and bearing2;\n * 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 arc\n * @param {number} bearing2 angle, in decimal degrees, of the second radius of the arc\n * @param {Object} [options={}] Optional parameters\n * @param {number} [options.steps=64] number of steps (straight segments) that will constitute the arc\n * @param {Units} [options.units='kilometers'] Supports all valid Turf {@link https://turfjs.org/docs/api/types/Units Units}.\n * @returns {Feature<LineString>} line arc\n * @example\n * var center = turf.point([-75, 40]);\n * var radius = 5;\n * var bearing1 = 25;\n * var bearing2 = 47;\n *\n * var arc = turf.lineArc(center, radius, bearing1, bearing2);\n *\n * //addToMap\n * var addToMap = [center, arc]\n */\nfunction lineArc(\n center: Coord,\n radius: number,\n bearing1: number,\n bearing2: number,\n options: {\n steps?: number;\n units?: Units;\n } = {}\n): Feature<LineString> {\n // default params\n const steps = options.steps || 64;\n\n const angle1 = convertAngleTo360(bearing1);\n const angle2 = convertAngleTo360(bearing2);\n const properties =\n !Array.isArray(center) && center.type === \"Feature\"\n ? center.properties\n : {};\n\n // handle angle parameters\n if (angle1 === angle2) {\n return lineString(\n circle(center, radius, options).geometry.coordinates[0],\n properties\n );\n }\n const arcStartDegree = angle1;\n const arcEndDegree = angle1 < angle2 ? angle2 : angle2 + 360;\n\n let alpha = arcStartDegree;\n const coordinates = [];\n let i = 0;\n // How many degrees we'll swing around between each step.\n const arcStep = (arcEndDegree - arcStartDegree) / steps;\n // Add coords to the list, increasing the angle from our start bearing\n // (alpha) by arcStep degrees until we reach the end bearing.\n while (alpha <= arcEndDegree) {\n coordinates.push(\n destination(center, radius, alpha, options).geometry.coordinates\n );\n i++;\n alpha = arcStartDegree + i * arcStep;\n }\n return lineString(coordinates, 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 { lineArc };\nexport default lineArc;\n"]}
|
package/dist/cjs/index.d.cts
CHANGED
|
@@ -12,7 +12,7 @@ import { Coord, Units } from '@turf/helpers';
|
|
|
12
12
|
* @param {number} bearing2 angle, in decimal degrees, of the second radius of the arc
|
|
13
13
|
* @param {Object} [options={}] Optional parameters
|
|
14
14
|
* @param {number} [options.steps=64] number of steps (straight segments) that will constitute the arc
|
|
15
|
-
* @param {
|
|
15
|
+
* @param {Units} [options.units='kilometers'] Supports all valid Turf {@link https://turfjs.org/docs/api/types/Units Units}.
|
|
16
16
|
* @returns {Feature<LineString>} line arc
|
|
17
17
|
* @example
|
|
18
18
|
* var center = turf.point([-75, 40]);
|
package/dist/esm/index.d.ts
CHANGED
|
@@ -12,7 +12,7 @@ import { Coord, Units } from '@turf/helpers';
|
|
|
12
12
|
* @param {number} bearing2 angle, in decimal degrees, of the second radius of the arc
|
|
13
13
|
* @param {Object} [options={}] Optional parameters
|
|
14
14
|
* @param {number} [options.steps=64] number of steps (straight segments) that will constitute the arc
|
|
15
|
-
* @param {
|
|
15
|
+
* @param {Units} [options.units='kilometers'] Supports all valid Turf {@link https://turfjs.org/docs/api/types/Units Units}.
|
|
16
16
|
* @returns {Feature<LineString>} line arc
|
|
17
17
|
* @example
|
|
18
18
|
* var center = turf.point([-75, 40]);
|
package/dist/esm/index.js
CHANGED
|
@@ -35,9 +35,9 @@ function convertAngleTo360(alpha) {
|
|
|
35
35
|
}
|
|
36
36
|
return beta;
|
|
37
37
|
}
|
|
38
|
-
var
|
|
38
|
+
var index_default = lineArc;
|
|
39
39
|
export {
|
|
40
|
-
|
|
40
|
+
index_default as default,
|
|
41
41
|
lineArc
|
|
42
42
|
};
|
|
43
43
|
//# sourceMappingURL=index.js.map
|
package/dist/esm/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../index.ts"],"sourcesContent":["import { Feature, LineString } from \"geojson\";\nimport { circle } from \"@turf/circle\";\nimport { destination } from \"@turf/destination\";\nimport { Coord, lineString, Units } from \"@turf/helpers\";\n\n/**\n * Creates a circular arc, of a circle of the given radius and center point, between bearing1 and bearing2;\n * 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 arc\n * @param {number} bearing2 angle, in decimal degrees, of the second radius of the arc\n * @param {Object} [options={}] Optional parameters\n * @param {number} [options.steps=64] number of steps (straight segments) that will constitute the arc\n * @param {
|
|
1
|
+
{"version":3,"sources":["../../index.ts"],"sourcesContent":["import { Feature, LineString } from \"geojson\";\nimport { circle } from \"@turf/circle\";\nimport { destination } from \"@turf/destination\";\nimport { Coord, lineString, Units } from \"@turf/helpers\";\n\n/**\n * Creates a circular arc, of a circle of the given radius and center point, between bearing1 and bearing2;\n * 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 arc\n * @param {number} bearing2 angle, in decimal degrees, of the second radius of the arc\n * @param {Object} [options={}] Optional parameters\n * @param {number} [options.steps=64] number of steps (straight segments) that will constitute the arc\n * @param {Units} [options.units='kilometers'] Supports all valid Turf {@link https://turfjs.org/docs/api/types/Units Units}.\n * @returns {Feature<LineString>} line arc\n * @example\n * var center = turf.point([-75, 40]);\n * var radius = 5;\n * var bearing1 = 25;\n * var bearing2 = 47;\n *\n * var arc = turf.lineArc(center, radius, bearing1, bearing2);\n *\n * //addToMap\n * var addToMap = [center, arc]\n */\nfunction lineArc(\n center: Coord,\n radius: number,\n bearing1: number,\n bearing2: number,\n options: {\n steps?: number;\n units?: Units;\n } = {}\n): Feature<LineString> {\n // default params\n const steps = options.steps || 64;\n\n const angle1 = convertAngleTo360(bearing1);\n const angle2 = convertAngleTo360(bearing2);\n const properties =\n !Array.isArray(center) && center.type === \"Feature\"\n ? center.properties\n : {};\n\n // handle angle parameters\n if (angle1 === angle2) {\n return lineString(\n circle(center, radius, options).geometry.coordinates[0],\n properties\n );\n }\n const arcStartDegree = angle1;\n const arcEndDegree = angle1 < angle2 ? angle2 : angle2 + 360;\n\n let alpha = arcStartDegree;\n const coordinates = [];\n let i = 0;\n // How many degrees we'll swing around between each step.\n const arcStep = (arcEndDegree - arcStartDegree) / steps;\n // Add coords to the list, increasing the angle from our start bearing\n // (alpha) by arcStep degrees until we reach the end bearing.\n while (alpha <= arcEndDegree) {\n coordinates.push(\n destination(center, radius, alpha, options).geometry.coordinates\n );\n i++;\n alpha = arcStartDegree + i * arcStep;\n }\n return lineString(coordinates, 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 { lineArc };\nexport default lineArc;\n"],"mappings":";AACA,SAAS,cAAc;AACvB,SAAS,mBAAmB;AAC5B,SAAgB,kBAAyB;AA0BzC,SAAS,QACP,QACA,QACA,UACA,UACA,UAGI,CAAC,GACgB;AAErB,QAAM,QAAQ,QAAQ,SAAS;AAE/B,QAAM,SAAS,kBAAkB,QAAQ;AACzC,QAAM,SAAS,kBAAkB,QAAQ;AACzC,QAAM,aACJ,CAAC,MAAM,QAAQ,MAAM,KAAK,OAAO,SAAS,YACtC,OAAO,aACP,CAAC;AAGP,MAAI,WAAW,QAAQ;AACrB,WAAO;AAAA,MACL,OAAO,QAAQ,QAAQ,OAAO,EAAE,SAAS,YAAY,CAAC;AAAA,MACtD;AAAA,IACF;AAAA,EACF;AACA,QAAM,iBAAiB;AACvB,QAAM,eAAe,SAAS,SAAS,SAAS,SAAS;AAEzD,MAAI,QAAQ;AACZ,QAAM,cAAc,CAAC;AACrB,MAAI,IAAI;AAER,QAAM,WAAW,eAAe,kBAAkB;AAGlD,SAAO,SAAS,cAAc;AAC5B,gBAAY;AAAA,MACV,YAAY,QAAQ,QAAQ,OAAO,OAAO,EAAE,SAAS;AAAA,IACvD;AACA;AACA,YAAQ,iBAAiB,IAAI;AAAA,EAC/B;AACA,SAAO,WAAW,aAAa,UAAU;AAC3C;AAUA,SAAS,kBAAkB,OAAe;AACxC,MAAI,OAAO,QAAQ;AACnB,MAAI,OAAO,GAAG;AACZ,YAAQ;AAAA,EACV;AACA,SAAO;AACT;AAGA,IAAO,gBAAQ;","names":[]}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@turf/line-arc",
|
|
3
|
-
"version": "7.
|
|
4
|
-
"description": "
|
|
3
|
+
"version": "7.3.1",
|
|
4
|
+
"description": "Creates a circular arc, of a circle of the given radius and center point, between two bearings.",
|
|
5
5
|
"author": "Turf Authors",
|
|
6
6
|
"license": "MIT",
|
|
7
7
|
"bugs": {
|
|
@@ -45,29 +45,28 @@
|
|
|
45
45
|
"bench": "tsx bench.ts",
|
|
46
46
|
"build": "tsup --config ../../tsup.config.ts",
|
|
47
47
|
"docs": "tsx ../../scripts/generate-readmes.ts",
|
|
48
|
-
"test": "
|
|
48
|
+
"test": "pnpm run /test:.*/",
|
|
49
49
|
"test:tape": "tsx test.ts",
|
|
50
50
|
"test:types": "tsc --esModuleInterop --module node16 --moduleResolution node16 --noEmit --strict types.ts"
|
|
51
51
|
},
|
|
52
52
|
"devDependencies": {
|
|
53
|
-
"@turf/truncate": "
|
|
53
|
+
"@turf/truncate": "7.3.1",
|
|
54
54
|
"@types/benchmark": "^2.1.5",
|
|
55
|
-
"@types/tape": "^
|
|
55
|
+
"@types/tape": "^5.8.1",
|
|
56
56
|
"benchmark": "^2.1.4",
|
|
57
57
|
"load-json-file": "^7.0.1",
|
|
58
|
-
"npm-run-all": "^4.1.5",
|
|
59
58
|
"tape": "^5.9.0",
|
|
60
|
-
"tsup": "^8.
|
|
61
|
-
"tsx": "^4.19.
|
|
62
|
-
"typescript": "^5.
|
|
63
|
-
"write-json-file": "^
|
|
59
|
+
"tsup": "^8.4.0",
|
|
60
|
+
"tsx": "^4.19.4",
|
|
61
|
+
"typescript": "^5.8.3",
|
|
62
|
+
"write-json-file": "^6.0.0"
|
|
64
63
|
},
|
|
65
64
|
"dependencies": {
|
|
66
|
-
"@turf/circle": "
|
|
67
|
-
"@turf/destination": "
|
|
68
|
-
"@turf/helpers": "
|
|
65
|
+
"@turf/circle": "7.3.1",
|
|
66
|
+
"@turf/destination": "7.3.1",
|
|
67
|
+
"@turf/helpers": "7.3.1",
|
|
69
68
|
"@types/geojson": "^7946.0.10",
|
|
70
69
|
"tslib": "^2.8.1"
|
|
71
70
|
},
|
|
72
|
-
"gitHead": "
|
|
71
|
+
"gitHead": "b7f1b4eafb760431e03955499d8eac9489438219"
|
|
73
72
|
}
|