Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
realistic-structured-clone
Advanced tools
Readme
You might not need this anymore! A native structuredClone
function is available in many recent environments, such as Node v17 and Firefox v94. Check if your target environment has structuredClone
built in. If it does, use that.
This is a pure JS implementation of the structured clone algorithm (or at least something pretty close to that).
Why do you want this? Well, you probably don't. If your goal is to just clone a JS object, you're better off with lodash's _.cloneDeep or the popular clone
module on npm.
Let's try again... why do you want this? If you are making an implementation of an API that explicitly uses the structured clone algorithm (such as IndexedDB), then you want something that handles quirks and edge cases exactly like the structured clone algorithm. That's what realistic-structured-clone
is for. It's not totally there (see below) but it's a decent start.
$ npm install realistic-structured-clone
Then use it:
// First load the module
// (Use Browserify or something if you're targeting the web)
var structuredClone = require('realistic-structured-clone');
// Clone a variable (will throw a DataCloneError for invalid input)
var clonedX = structuredClone(x);
If you look around, you'll notice various modules calling themselves implementations of the structured clone algorithm, such as the structured-clone
package on npm. But that package, like all the others I've seen, doesn't actually seem to be an attempt at implementing the structured clone algorithm. It's just some arbitrary type of clone. As I wrote above, this distinction only matters if you really care about the nuances of the structured clone algorithm, which you probably don't.
If you're working in the browser, you can do something like this to do a real structured clone:
function clone(x) {
return new Promise(function (resolve, reject) {
window.addEventListener('message', function(e) {
resolve(e.data);
});
window.postMessage(x, "*");
});
}
var x = {a:[1,2,3], b:{c:1}};
clone(x).then(function(cloned) {
console.log("x: %s", JSON.stringify(x));
console.log("cloned: %s", JSON.stringify(cloned));
console.log("x == cloned %s", x == cloned);
console.log("x === cloned %s", x === cloned);
});
However, that won't help you in Node.js. It's also asynchronous, which could be a problem. realistic-structured-clone
is synchronous and works everywhere.
As of version 2.0, it should be pretty damn close to the spec! However it is now just a light wrapper around the Typeson structured-cloning-throwing preset.
Apache 2.0
FAQs
A pure JS implementation of the structured clone algorithm (or at least something pretty close to that)
The npm package realistic-structured-clone receives a total of 138,238 weekly downloads. As such, realistic-structured-clone popularity was classified as popular.
We found that realistic-structured-clone demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.