feat: allow number in nonce callback (#5)

feat:

- allow `number` in `nonce` callback
- export `tsonNumberGuard`
- update README

CHANGELOG.md

@@ -1,11 +1,8 @@
-
-
 ## [0.3.1](https://github.com/KATT/tupleson/compare/0.3.0...0.3.1) (2023-09-30)
 
-
 ### Bug Fixes
 
-* `serializer` -> `serialize` ([#4](https://github.com/KATT/tupleson/issues/4)) ([93a45a5](https://github.com/KATT/tupleson/commit/93a45a5e32ad1ebddba6283627551830c1e621ec))
+- `serializer` -> `serialize` ([#4](https://github.com/KATT/tupleson/issues/4)) ([93a45a5](https://github.com/KATT/tupleson/commit/93a45a5e32ad1ebddba6283627551830c1e621ec))
 
 # [0.3.0](https://github.com/KATT/tupleson/compare/0.2.0...0.3.0) (2023-09-30)
 
@@ -24,4 +21,4 @@
 ### Features
 
 - initial version ([#1](https://github.com/KATT/tupleson/issues/1)) ([ccce25b](https://github.com/KATT/tupleson/commit/ccce25b6a039cf2e5c1a774c1ab022f0946ca8d5))
-- initialized repo ✨ ([c9e92a4](https://github.com/KATT/tupleson/commit/c9e92a42c97a8bc1ee3a9214f65626425c8598e3))
+- initialized repo ✨ ([c9e92a4](https://github.com/KATT/tupleson/commit/c9e92a42c97a8bc1ee3a9214f65626425c8598e3))

README.md

@@ -30,11 +30,36 @@ A hackable JSON serializer/deserializer that allows you to serialize/deserialize
 ### Example
 
 ```ts
+/* eslint-disable eslint-comments/disable-enable-pair, @typescript-eslint/no-unused-vars, n/no-missing-import */
+
+import {
+	createTupleson,
+	// Serialize `bigint`
+	tsonBigint,
+	// Serialize `Map`s
+	tsonMap,
+	// **throws** when encountering Infinity or NaN
+	tsonNumberGuard,
+	// Serialize regular expression
+	tsonRegExp,
+	// Serialize `Set`s
+	tsonSet,
+	// Serialize `URL`s
+	tsonURL,
+	// Serialize `undefined`
+	tsonUndefined,
+	// **throws** when encountering non-registered complex objects (like class instances)
+	tsonUnknownObjectGuard,
+} from "tupleson";
+
 const json = createTupleson({
 	// This nonce function is used to generate a nonce for the serialized value
 	// This is used to identify the value as a serialized value
 	nonce: () => "__tson",
-	types: [tsonSet],
+	types: [
+		// Pick which types you want to support
+		tsonSet,
+	],
 });
 
 const result = json.stringify(
@@ -45,6 +70,30 @@ const result = json.stringify(
 	2,
 );
 console.log(result);
+// ->
+// {
+//   "json": {
+//     "foo": "bar",
+//     "set": [
+//       "Set",
+//       [
+//         1,
+//         2,
+//         3
+//       ],
+//       "__tson"
+//     ]
+//   },
+//   "nonce": "__tson"
+// }
+
+// ✨ Retains type integrity
+type Obj = typeof obj;
+//   ^?
+// type Obj = {
+//     readonly foo: "bar";
+//     readonly set: Set<number>;
+// }
 ```
 
 **Footnotes**:

src/handlers/index.ts

@@ -5,4 +5,5 @@ export * from "./tsonSet.js";
 export * from "./tsonMap.js";
 export * from "./tsonUndefined.js";
 export * from "./tsonUnknownObjectGuard.js";
-export * from "./tsonNumber.js";
+export * from "./tsonNumberGuard.js";
+export * from "./tsonURL.js";

src/handlers/tsonNumber.test.ts → src/handlers/tsonNumberGuard.test.ts

@@ -2,11 +2,11 @@ import { expect, test } from "vitest";
 
 import { expectError } from "../testUtils.js";
 import { createTupleson } from "../tson.js";
-import { tsonNumber } from "./tsonNumber.js";
+import { tsonNumberGuard } from "./tsonNumberGuard.js";
 
 test("number", () => {
 	const t = createTupleson({
-		types: [tsonNumber],
+		types: [tsonNumberGuard],
 	});
 
 	const bad = [

src/handlers/tsonNumber.ts → src/handlers/tsonNumberGuard.ts

@@ -4,7 +4,7 @@ import { TsonType } from "../types.js";
  * Prevents `NaN` and `Infinity` from being serialized
  */
 
-export const tsonNumber: TsonType<number, number> = {
+export const tsonNumberGuard: TsonType<number, number> = {
 	primitive: "number",
 	test: (v) => {
 		const value = v as number;

src/types.ts

@@ -95,7 +95,7 @@ export type TsonType<
 > = TsonTypeTester & TsonTransformer<TValue, TSerializedType>;
 
 export interface TsonOptions {
-	nonce?: () => string;
+	nonce?: () => number | string;
 	types: (TsonType<any, any> | TsonType<any, never>)[];
 }