\n\n- Can serialize circular references\n- In addition to JSON-serializable types can serialize:\n - `undefined`\n - `NaN`\n - `Date`\n - `RegExp`\n - `Error`[1](#note1)\n - `Map`[2](#note2)\n - `Set`[3](#note3)\n - `ArrayBuffer`[3](#note3)\n - Typed arrays[3](#note3)\n- [Can be extended with custom type transforms](#adding-custom-types-support)\n- [Can use any target serializer under the hood](#changing-serialization-format) (JSON, BSON, protobuf, etc.)\n\n----\n1: If decoding target platform doesn't support encoded error type, it will fallback to `Error` constructor. \n2: If decoding target platform doesn't support `Map`, it will be decoded as array of `[key, value]`. \n3: If decoding target platform doesn't support `Set`, `ArrayBuffer` or typed arrays, they will be decoded as array. \n\n## Install\n```shell\nnpm install replicator\n```\n\n## Usage\n```js\nconst Replicator = require('replicator');\n\nconst replicator = new Replicator();\n\nconst a = {};\na.b = a;\n\nconst str = replicator.encode({\n key1: new Set([1, 2, 3]),\n key2: /\\s+/ig,\n key3: a\n});\n\nconst obj = replicator.decode(str);\n```\n\n\n## Adding custom types support\nYou can extend `replicator` with custom type transform which will describe how to serialize/deserialize objects. You can\nadd transforms using `.addTransforms(transforms)` method. And remove them using `.removeTransforms(transforms)` method.\nBoth methods are chainable and accept single transform or array of transforms. You should add transforms to both encoding\nand decoding instances of `replicator`.\n\nLet's create transform which will encode `NodeList` of elements and decode it as array of objects with `tagName` property:\n```js\nconst Replicator = require('replicator');\n\nconst replicator = new Replicator();\n\nreplicator.addTransforms([\n {\n type: 'NodeList',\n\n shouldTransform (type, val) {\n return typeof NodeList === 'function' && val instanceof NodeList;\n },\n\n toSerializable (nodeList) {\n // We should transform NodeList to primitive serializable object.\n // It's an array of HTMLElement in our case.\n // Note that it's not required to transform each element in\n // NodeList. We can add HTMLElement transform which\n // will transform NodeList items and individual elements as well.\n return Array.prototype.slice.call(nodeList);\n },\n\n fromSerializable (val){\n // Now we should describe how to restore NodeList from serializable object.\n // In our case we just need an array so we'll return it as is.\n // If you want to restore it as NodeList you can create document fragment, append\n // array contents to it and return result of `fragment.querySelectorAll('*')` .\n return val;\n }\n },\n\n {\n type: 'Element',\n\n shouldTransform (type, val){\n return typeof HTMLElement === 'function' && val instanceof HTMLElement;\n },\n\n toSerializable (element) {\n return element.tagName;\n },\n\n fromSerializable (val) {\n return { tagName: val };\n }\n }\n]);\n\nvar str = replicator.encode(document.querySelectorAll('div'));\n\nconsole.log(replicator.decode(str));\n// > [ { tagName: 'div'}, { tagName: 'div'}, { tagName: 'div'}]\n```\n\nBuilt-in types support implemented using transforms, so you can take a look on `replicator` source code for more examples.\n\n## Changing serialization format\nBy default `replicator` uses JSON under the hood. But you can use any serializer by passing serializer adapter to `Replicator`\nconstructor. E.g., let's use [BSON](https://www.npmjs.com/package/bson) as serializer:\n```js\nconst Replicator = require('replicator');\nconst BSON = require('bson');\n\nconst replicator = new Replicator({\n serialize (val) {\n return BSON.serialize(val, false, true, false);\n },\n\n deserialize: BSON.deserialize\n});\n\nreplicator.encode(['yo', 42]);\n// > \n```\n\n## Author\n[Ivan Nikulin](https://github.com/inikulin) (ifaaan@gmail.com)\n","maintainers":[{"name":"inikulin","email":"ifaaan@gmail.com"},{"name":"amoskovkin","email":"henry71rus@gmail.com"},{"name":"belym.a.2105","email":"belym.a.2105@gmail.com"}],"time":{"modified":"2022-06-26T11:22:49.277Z","created":"2016-05-24T14:06:59.265Z","1.0.0":"2016-05-24T14:06:59.265Z","1.0.1":"2016-07-11T09:41:24.913Z","1.0.2":"2018-04-27T21:23:25.478Z","1.0.3":"2018-12-17T12:15:49.909Z","1.0.4":"2021-05-17T13:18:39.372Z","1.0.5":"2021-05-24T07:46:50.709Z"},"homepage":"https://github.com/inikulin/replicator#readme","keywords":["JSON","serialization","deserialization","circular","circularJSON","structured-clone","structured","clone"],"repository":{"type":"git","url":"git+https://github.com/inikulin/replicator.git"},"author":{"name":"Ivan Nikulin","url":"ifaaan@gmail.com"},"bugs":{"url":"https://github.com/inikulin/replicator/issues"},"license":"MIT","readmeFilename":"README.md"}
![\"replicator\"](\"https://raw.github.com/inikulin/replicator/master/media/logo.png\"){kind=logo}
\n \n![\"GitHub](\"https://img.shields.io/github/checks-status/inikulin/replicator/master?label=tests\")
![\"NPM](\"https://img.shields.io/npm/v/replicator.svg\")
\n