guard

src/handlers/index.ts

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

src/handlers/tsonUnknown.test.ts → src/handlers/tsonUnknownObjectGuard.test.ts

@@ -3,15 +3,18 @@ import { assert, expect, test } from "vitest";
 import { expectError } from "../testUtils.js";
 import { createTupleson } from "../tson.js";
 import { tsonSet } from "./tsonSet.js";
-import { UnknownObjectGuardError, tsonUnknown } from "./tsonUnknown.js";
+import {
+	UnknownObjectGuardError,
+	tsonUnknownObjectGuard,
+} from "./tsonUnknownObjectGuard.js";
 
 test("guard unwanted objects", () => {
 	// Sets are okay, but not Maps
 	const t = createTupleson({
 		types: [
 			tsonSet,
 			// defined last so it runs last
-			tsonUnknown,
+			tsonUnknownObjectGuard,
 		],
 	});
 

src/handlers/tsonUnknown.ts → src/handlers/tsonUnknownObjectGuard.ts

@@ -11,7 +11,12 @@ export class UnknownObjectGuardError extends Error {
 	}
 }
 
-export const tsonUnknown: TsonType<unknown, never> = {
+/**
+ * Guard against unknown complex objects
+ * @remark Make sure to define this last in the list of types
+ * @throws {UnknownObjectGuardError} if an unknown object is found
+ */
+export const tsonUnknownObjectGuard: TsonType<unknown, never> = {
 	test: (v) => {
 		if (v && typeof v === "object" && !Array.isArray(v) && !isPlainObject(v)) {
 			throw new UnknownObjectGuardError(v);