@turf/sector 6.5.0 → 7.0.0-alpha.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/README.md +12 -11
- package/dist/es/index.js +0 -0
- package/dist/js/index.js +0 -0
- package/index.d.ts +3 -2
- package/package.json +9 -9
package/README.md
CHANGED
|
@@ -7,18 +7,19 @@
|
|
|
7
7
|
Creates a circular sector of a circle of given radius and center [Point][1],
|
|
8
8
|
between (clockwise) bearing1 and bearing2; 0 bearing is North of center point, positive clockwise.
|
|
9
9
|
|
|
10
|
-
|
|
10
|
+
### Parameters
|
|
11
11
|
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
- `options.units` **[string][5]** miles, kilometers, degrees, or radians (optional, default `'kilometers'`)
|
|
18
|
-
- `options.steps` **[number][3]** number of steps (optional, default `64`)
|
|
19
|
-
- `options.properties` **Properties** Translate properties to Feature Polygon (optional, default `{}`)
|
|
12
|
+
* `center` **[Coord][2]** center point
|
|
13
|
+
* `radius` **[number][3]** radius of the circle
|
|
14
|
+
* `bearing1` **[number][3]** angle, in decimal degrees, of the first radius of the sector
|
|
15
|
+
* `bearing2` **[number][3]** angle, in decimal degrees, of the second radius of the sector
|
|
16
|
+
* `options` **[Object][4]** Optional parameters (optional, default `{}`)
|
|
20
17
|
|
|
21
|
-
**
|
|
18
|
+
* `options.units` **[string][5]** miles, kilometers, degrees, or radians (optional, default `'kilometers'`)
|
|
19
|
+
* `options.steps` **[number][3]** number of steps (optional, default `64`)
|
|
20
|
+
* `options.properties` **Properties** Translate properties to Feature Polygon (optional, default `{}`)
|
|
21
|
+
|
|
22
|
+
### Examples
|
|
22
23
|
|
|
23
24
|
```javascript
|
|
24
25
|
var center = turf.point([-75, 40]);
|
|
@@ -32,7 +33,7 @@ var sector = turf.sector(center, radius, bearing1, bearing2);
|
|
|
32
33
|
var addToMap = [center, sector];
|
|
33
34
|
```
|
|
34
35
|
|
|
35
|
-
Returns **[Feature][6]
|
|
36
|
+
Returns **[Feature][6]<[Polygon][7]>** sector polygon
|
|
36
37
|
|
|
37
38
|
[1]: https://tools.ietf.org/html/rfc7946#section-3.1.2
|
|
38
39
|
|
package/dist/es/index.js
CHANGED
|
File without changes
|
package/dist/js/index.js
CHANGED
|
File without changes
|
package/index.d.ts
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
|
-
import { Feature, Polygon,
|
|
1
|
+
import { Feature, Polygon, GeoJsonProperties } from "geojson";
|
|
2
|
+
import { Units, Coord } from "@turf/helpers";
|
|
2
3
|
|
|
3
4
|
/**
|
|
4
5
|
* http://turfjs.org/docs/#sector
|
|
@@ -11,6 +12,6 @@ export default function sector(
|
|
|
11
12
|
options?: {
|
|
12
13
|
steps?: number;
|
|
13
14
|
units?: Units;
|
|
14
|
-
properties?:
|
|
15
|
+
properties?: GeoJsonProperties;
|
|
15
16
|
}
|
|
16
17
|
): Feature<Polygon>;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@turf/sector",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "7.0.0-alpha.0",
|
|
4
4
|
"description": "turf sector module",
|
|
5
5
|
"author": "Turf Authors",
|
|
6
6
|
"license": "MIT",
|
|
@@ -41,10 +41,10 @@
|
|
|
41
41
|
"docs": "node ../../scripts/generate-readmes",
|
|
42
42
|
"test": "npm-run-all test:*",
|
|
43
43
|
"test:tape": "node -r esm test.js",
|
|
44
|
-
"test:types": "tsc --esModuleInterop --noEmit types.ts"
|
|
44
|
+
"test:types": "tsc --esModuleInterop --noEmit --strict types.ts"
|
|
45
45
|
},
|
|
46
46
|
"devDependencies": {
|
|
47
|
-
"@turf/truncate": "^
|
|
47
|
+
"@turf/truncate": "^7.0.0-alpha.0",
|
|
48
48
|
"benchmark": "*",
|
|
49
49
|
"load-json-file": "*",
|
|
50
50
|
"npm-run-all": "*",
|
|
@@ -53,11 +53,11 @@
|
|
|
53
53
|
"write-json-file": "*"
|
|
54
54
|
},
|
|
55
55
|
"dependencies": {
|
|
56
|
-
"@turf/circle": "^
|
|
57
|
-
"@turf/helpers": "^
|
|
58
|
-
"@turf/invariant": "^
|
|
59
|
-
"@turf/line-arc": "^
|
|
60
|
-
"@turf/meta": "^
|
|
56
|
+
"@turf/circle": "^7.0.0-alpha.0",
|
|
57
|
+
"@turf/helpers": "^7.0.0-alpha.0",
|
|
58
|
+
"@turf/invariant": "^7.0.0-alpha.0",
|
|
59
|
+
"@turf/line-arc": "^7.0.0-alpha.0",
|
|
60
|
+
"@turf/meta": "^7.0.0-alpha.0"
|
|
61
61
|
},
|
|
62
|
-
"gitHead": "
|
|
62
|
+
"gitHead": "0edc4c491b999e5ace770a61e1cf549f7c004189"
|
|
63
63
|
}
|