@turf/clone

What is @turf/clone?

@turf/clone is a module within the Turf.js library that allows you to create deep copies of GeoJSON objects. This is particularly useful when you need to manipulate or transform GeoJSON data without altering the original dataset.

What are @turf/clone's main functionalities?

Clone a Point

This feature allows you to clone a GeoJSON Point object. The code sample demonstrates how to create a point and then clone it using the @turf/clone module.

const turf = require('@turf/turf');
const point = turf.point([0, 0]);
const clonedPoint = turf.clone(point);
console.log(clonedPoint);

Clone a Polygon

This feature allows you to clone a GeoJSON Polygon object. The code sample demonstrates how to create a polygon and then clone it using the @turf/clone module.

const turf = require('@turf/turf');
const polygon = turf.polygon([[[0, 0], [10, 0], [10, 10], [0, 10], [0, 0]]]);
const clonedPolygon = turf.clone(polygon);
console.log(clonedPolygon);

Clone a Feature Collection

This feature allows you to clone a GeoJSON Feature Collection. The code sample demonstrates how to create a feature collection and then clone it using the @turf/clone module.

const turf = require('@turf/turf');
const featureCollection = turf.featureCollection([turf.point([0, 0]), turf.point([1, 1])]);
const clonedFeatureCollection = turf.clone(featureCollection);
console.log(clonedFeatureCollection);

Other packages similar to @turf/clone

lodash

Lodash is a popular utility library that includes a deep clone function (lodash.cloneDeep) which can be used to clone GeoJSON objects. While it is not specifically designed for GeoJSON, it is a versatile tool that can handle various data types.

rfdc

The rfdc (Really Fast Deep Clone) package is a highly efficient deep cloning library that can be used to clone GeoJSON objects. It is known for its performance and minimal footprint, making it a good alternative for cloning operations.

README

@turf/clone

clone

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

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

Parameters

• geojson GeoJSON GeoJSON Object
• cloneAll [Boolean] clones entire GeoJSON (3-20x slower if True) (optional, default false)

Examples

var line = {
  "type": "Feature",
  "properties": {},
  "geometry": {
    "type": "LineString",
    "coordinates": [[-74, 40], [-78, 42], [-82, 35]]
  }
}
var lineCloned = turf.clone(line);

Returns GeoJSON cloned GeoJSON Object

---

This module is part of the Turfjs project, an open source module collection dedicated to geographic algorithms. It is maintained in the Turfjs/turf repository, where you can create PRs and issues.

Installation

Install this module individually:

$ npm install @turf/clone

Or install the Turf module that includes it as a function:

$ npm install @turf/turf