@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

Returns a cloned copy of the passed GeoJSON Object, including possible 'Foreign Members'. ~3-5x faster than the common JSON.parse + JSON.stringify combo method.

Parameters

• geojson GeoJSON GeoJSON Object

Examples

var line = turf.lineString([[-74, 40], [-78, 42], [-82, 35]], {color: 'red'});

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

Changelog

6.2.0

After a bit of hiatus, TurfJS is resuming releases.

⭐️ Major Updates

• ES Modules available for all packages
• Tree shaking should significantly reduce import size of @turf/turf
• Better support for ESM modules (PR https://github.com/Turfjs/turf/pull/1942 - Author @diachedelic)
• Clean-up of test and benchmark running to make publishing easier
• Enforce styling using Prettier
• Enable ESLint and get rid of unused variables
• Upgrade rollup for more correct javascript module builds
• Only include ES5 code

🚀 New Modules

[@turf/boolean-touches][boolean-touches]

Determines if two features touch but do not intersect

[@turf/boolean-valid][boolean-valid]

Checks if the geometry is a valid according to the OGC Simple Feature Specification

[@turf/quadrat-analysis][quadrat-analysis]

Performs a quadrat analysis on a set of points

[@turf/rectangle-grid][rectangle-grid]

Creates a grid of rectangles from a bounding box

[@turf/voroni][voronoi]

Typescript types for the options parameter have been fixed (PR https://github.com/Turfjs/turf/pull/1424 - Author @stevage)

[@turf/points-within-polygon][points-within-polygon]

Typescript types around the Feature's Properties will now be preserved. (PR https://github.com/Turfjs/turf/pull/1761 - Author @rugheid)

[@turf/rewind][rewind]

Typescript types for the 'reverse' option are now correct. Previously it was misnamed as 'reversed'. (PR https://github.com/Turfjs/turf/pull/1786 - Author @jonnycornwell)

[@turf/difference][difference]

No longer publishes an .mjs file.

[@turf/meta][meta]

No longer publishes an .mjs file.

[@turf/tag][tag]

Add MultiPolygon support. (PR https://github.com/Turfjs/turf/pull/1996 - Author bryceroney)

🐛 Bug Fixes

• @turf/centroid Don't visit first point twice when calculating centroid (PR https://github.com/Turfjs/turf/pull/1894 - Author @rowanwins)

• @turf/transform-translate Better handling of negative distances (PR https://github.com/Turfjs/turf/pull/1895 - Author @rowanwins)

• @turf/union, @turf/difference, @turf/intersect Use polygon-clipping library to fix correctness issues (PR https://github.com/Turfjs/turf/pull/1916 - Authors @mbullington, @ngottlieb)

• @turf/buffer Change default number of steps to 8, and actually support the steps option (PR https://github.com/Turfjs/turf/pull/1931 - Author stevenchanin)

• @turf/buffer Fix projection issues that produce undersized buffers at non-equatorial latitudes (PR https://github.com/Turfjs/turf/pull/1956 - Author dyakovlev)

• @turf/helpers Add runtime checks to point() method, fixing an API break (PR https://github.com/Turfjs/turf/pull/1964)

🏅 New Features/Enhancements

• @turf/boolean-overlap Better performance for MultiPoint geometries (PR https://github.com/Turfjs/turf/pull/1910 - Author @mfedderly)

• @turf/helpers Add hectares to convertArea (PR https://github.com/Turfjs/turf/pull/1943 - Author @DanielJDufour)

• @turf/great-circle Update Typescript types to support MultiLineString input (PR https://github.com/Turfjs/turf/pull/1928 - Author kronick)

📖 Documentation

• @turf/square-grid Clarify inputs (PR https://github.com/Turfjs/turf/pull/1885 - Author @raphael-leger)

• @turf/greater-circle Clarify properties option example (PR https://github.com/Turfjs/turf/pull/1888 - Author @chris-catignani)

⚠️ Breaking Change

• @turf/line-to-polygon no longer modifies its input unless the mutate option is true (PR https://github.com/Turfjs/turf/pull/1879 - Author @MortenBirk)

• @turf/unkink-polygon remove Number.prototype.modulo override (PR https://github.com/Turfjs/turf/pull/1978)