\n\n---\n\nCustomizable serialization & deserialization.\nSerialize almost[^1] anything!\n\n[^1]:\n 🌀 Circular references not your thing? We agree & we don't support it.\n But hey, feel free to make a PR add opt-in support for that if you need it!\n\n### 🎯 Project Goals\n\n- 💡 JSON-compatible output\n- 📖 Human-readable output\n- 🔧 Customizable behavior – tailor it to your exact needs\n- 🌊 Serialize & stream things like `Promise`s or async iterators\n\n> [!IMPORTANT] \n> _Though well-tested, this package might undergo big changes and **does not** follow semver whilst on `0.x.y`-version, stay tuned!_\n\n### 👀 Example\n\n```ts\n/* eslint-disable @typescript-eslint/no-unused-vars, n/no-missing-import */\n\nimport {\n\t// Create serializer / deserializer\n\tcreateTson,\n\t// Serialize `bigint`\n\ttsonBigint,\n\t// Serialize `Date`\n\ttsonDate,\n\t// Serialize `Map`s\n\ttsonMap,\n\t// **throws** when encountering Infinity or NaN\n\ttsonNumberGuard,\n\t// Serialize regular expression\n\ttsonRegExp,\n\t// Serialize `Set`s\n\ttsonSet,\n\t// serialize a Symbol\n\ttsonSymbol,\n\t// Serialize `URL`s\n\ttsonURL,\n\t// Serialize `undefined`\n\ttsonUndefined,\n\t// **throws** when encountering non-registered complex objects (like class instances)\n\ttsonUnknownObjectGuard,\n} from \"tupleson\";\n\nconst tson = createTson({\n\t/**\n\t * The nonce function every time we start serializing a new object\n\t * Should return a unique value every time it's called\n\t * @default `${crypto.randomUUID} if available, otherwise a random string generated by Math.random`\n\t */\n\t// nonce: () => \"__tson\",\n\ttypes: [\n\t\t// Pick which types you want to support\n\t\ttsonSet,\n\t],\n});\n\nconst myObj = {\n\tfoo: \"bar\",\n\tset: new Set([1, 2, 3]),\n};\n\nconst str = tson.stringify(myObj, 2);\nconsole.log(str);\n// (👀 All non-JSON values are replaced with a tuple, hence the name)\n\n// ->\n// {\n// \"json\": {\n// \"foo\": \"bar\",\n// \"set\": [\n// \"Set\",\n// [\n// 1,\n// 2,\n// 3\n// ],\n// \"__tson\"\n// ]\n// },\n// \"nonce\": \"__tson\"\n// }\n\nconst obj = tson.parse(str);\n\n// ✨ Retains type integrity\ntype Obj = typeof obj;\n// ^?\n// -> type Obj = { foo: string; set: Set; }\n```\n\n### 🤯 Streaming `Promise`s and `AsyncIterable`s\n\n- See example in [`./examples/async`](./examples/async)\n- [Test it on StackBlitz](https://stackblitz.com/github/trpc/tupleson/tree/main/examples/async?file=src/app/page.tsx)\n\n## 🧩 Extend with a custom serializer\n\n> [!IMPORTANT]\n> When defining custom serializers, the array order matters! If a value passes the test for more than one custom serializer, the first wins.\n\n### ⌚️ [Temporal](https://www.npmjs.com/package/@js-temporal/polyfill)\n\n> See test reference in [`./src/extend/temporal.test.ts`](./src/extend/temporal.test.ts)\n\n```ts\n/* eslint-disable @typescript-eslint/no-unused-vars, n/no-missing-import, n/no-unpublished-import */\nimport { Temporal } from \"@js-temporal/polyfill\";\nimport { TsonType, createTson } from \"tupleson\";\n\nconst plainDate: TsonType = {\n\tdeserialize: (v) => Temporal.PlainDate.from(v),\n\tkey: \"PlainDate\",\n\tserialize: (v) => v.toJSON(),\n\ttest: (v) => v instanceof Temporal.PlainDate,\n};\n\nconst instant: TsonType = {\n\tdeserialize: (v) => Temporal.Instant.from(v),\n\tkey: \"Instant\",\n\tserialize: (v) => v.toJSON(),\n\ttest: (v) => v instanceof Temporal.Instant,\n};\n\nconst tson = createTson({\n\ttypes: [plainDate, instant],\n});\n```\n\n### 🧮 [Decimal.js](https://github.com/MikeMcl/decimal.js)\n\n> See test reference in [`./src/extend/decimal.test.ts`](./src/extend/decimal.test.ts)\n\n```ts\n/* eslint-disable @typescript-eslint/no-unused-vars, n/no-missing-import, n/no-unpublished-import */\nimport { Decimal } from \"decimal.js\";\n\nconst decimalJs: TsonType = {\n\tdeserialize: (v) => new Decimal(v),\n\tkey: \"Decimal\",\n\tserialize: (v) => v.toJSON(),\n\ttest: (v) => v instanceof Decimal,\n};\n\nconst tson = createTson({\n\ttypes: [decimalJs],\n});\n```\n\n---\n\n\n\n\n\n\n\n> 💙 This package is based on [@JoshuaKGoldberg](https://github.com/JoshuaKGoldberg)'s [create-typescript-app](https://github.com/JoshuaKGoldberg/create-typescript-app).\n","readmeFilename":"README.md"}
![\"All](\"https://img.shields.io/badge/all_contributors-2-21bb42.svg\"){kind=icon}
\n\n\n\n\t\n\t\t![\"Codecov](\"https://codecov.io/gh/trpc/tupleson/branch/main/graph/badge.svg\"/){kind=icon}
\n\t\n\t\n\t\t![\"Contributor](\"https://img.shields.io/badge/code_of_conduct-enforced-21bb42\"){kind=icon}
\n\t\n\t\n\t\t![\"License:](\"https://img.shields.io/github/license/trpc/tupleson?color=21bb42\")
\n\t\n\t![\"Style:](\"https://img.shields.io/badge/style-prettier-21bb42.svg\"){kind=icon}
\n\t![\"TypeScript:](\"https://img.shields.io/badge/typescript-strict-21bb42.svg\"){kind=icon}
\n