Implement Clone module

[DenisCarriere]

New module! 🎉 @turf/clone

Prevents GeoJSON coordinates from being mutated, similar to JSON.parse(JSON.stringify(geojson)).

Only cloning the coordinates can be 3x-20x faster than the parse + stringify approach.

JSDocs

/**
 * Prevents GeoJSON coordinates from being mutated, similar to JSON.parse(JSON.stringify(geojson)).
 *
 * @name clone
 * @param {GeoJSON} geojson GeoJSON Object
 * @param {Boolean} [cloneAll=false] clones entire GeoJSON (3-20x slower if True)
 * @returns {GeoJSON} cloned GeoJSON Object
 * @example
 * var line = {
 *   "type": "Feature",
 *   "properties": {},
 *   "geometry": {
 *     "type": "LineString",
 *     "coordinates": [[-74, 40], [-78, 42], [-82, 35]]
 *   }
 * }
 * var lineCloned = turf.clone(line);
 */

Benchmark Results

Benchmark Results

Point x 6,972,739 ops/sec ±5.50% (86 runs sampled)
Point -- clones entire object x 357,437 ops/sec ±0.95% (88 runs sampled)
LineString x 1,502,039 ops/sec ±1.01% (86 runs sampled)
LineString -- clones entire object x 291,562 ops/sec ±1.00% (88 runs sampled)
Polygon x 723,111 ops/sec ±1.06% (87 runs sampled)
Polygon -- clones entire object x 227,034 ops/sec ±0.62% (91 runs sampled)
FeatureCollection x 370,012 ops/sec ±1.25% (87 runs sampled)
FeatureCollection -- clones entire object x 91,582 ops/sec ±0.81% (86 runs sampled)