Publish new module @turf/rewind

[DenisCarriere]

New Module @turf/rewind 🎉

Rewind LineString or Polygon outer ring clockwise and inner rings counterclockwise (Uses Shoelace Formula).

Ref Issues: #250 #66

Contributors

• Abel Vázquez Montoro @AbelVM - Inspired by turf-rewind
• Tom MacWright @tmcw - Inspired by @mapbox/geojson-rewind
• Morgan Herlocker @morganherlocker - Inspired by turf-is-clockwise
• Denis Carriere @DenisCarriere - Implement module to TurfJS mono repo

Geometry Support

• (Multi)Polygon
• (Multi)LineString

JSDocs

/**
 * Rewind {@link LineString|(Mutli)LineString} or {@link Polygon|(Multi)Polygon} outer ring clockwise and inner rings counterclockwise (Uses {@link https://en.wikipedia.org/wiki/Shoelace_formula|Shoelace Formula}).
 *
 * @name rewind
 * @param {Feature<Polygon|MultiPolygon|LineString|MultiLineString>} geojson input GeoJSON Polygon
 * @param {Boolean} [reverse=false] enable reverse winding
 * @param {boolean} [mutate=false] allows GeoJSON input to be mutated (significant performance increase if true)
 * @returns {Feature<Polygon|MultiPolygon|LineString|MultiLineString>} rewind Polygon
 * @example
 * var polygon = {
 *     "type": "Feature",
 *     "properties": {},
 *     "geometry": {
 *         "type": "Polygon",
 *         "coordinates": [
 *             [[121, -29], [138, -29], [138, -18], [121, -18], [121, -29]]
 *         ]
 *     }
 * };
 * var rewind = turf.rewind(polygon);
 *
 * //addToMap
 * var addToMap = [rewind];
 */

Benchmark Results

Blazing fast 🔥

geometry-polygon-counter-clockwise x 3,217,454 ops/sec ±4.31% (83 runs sampled)
line-clockwise x 2,249,133 ops/sec ±0.97% (90 runs sampled)
line-counter-clockwise x 2,224,334 ops/sec ±1.40% (87 runs sampled)
polygon-clockwise x 3,429,437 ops/sec ±1.49% (86 runs sampled)
polygon-counter-clockwise x 3,464,880 ops/sec ±1.05% (88 runs sampled)

Example

Polygon with outer ring as counter-clockwise

Using @turf/rewind re-orders outer ring as clockwise

CC: @Turfjs/ownership