feat: createTypeson -> createTson (#6)

CHANGELOG.md

@@ -1,11 +1,8 @@
-
-
 # [0.4.0](https://github.com/KATT/tupleson/compare/0.3.1...0.4.0) (2023-09-30)
 
-
 ### Features
 
-* allow `number` in `nonce` callback ([#5](https://github.com/KATT/tupleson/issues/5)) ([d2fcb7f](https://github.com/KATT/tupleson/commit/d2fcb7f5175705bf1ec01fc67b8ed2feacdcac7d))
+- allow `number` in `nonce` callback ([#5](https://github.com/KATT/tupleson/issues/5)) ([d2fcb7f](https://github.com/KATT/tupleson/commit/d2fcb7f5175705bf1ec01fc67b8ed2feacdcac7d))
 
 ## [0.3.1](https://github.com/KATT/tupleson/compare/0.3.0...0.3.1) (2023-09-30)
 
@@ -30,4 +27,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

@@ -33,7 +33,8 @@ A hackable JSON serializer/deserializer that allows you to serialize/deserialize
 /* eslint-disable eslint-comments/disable-enable-pair, @typescript-eslint/no-unused-vars, n/no-missing-import */
 
 import {
-	createTupleson,
+	// Create serializer / deserializer
+	createTson,
 	// Serialize `bigint`
 	tsonBigint,
 	// Serialize `Map`s
@@ -52,7 +53,7 @@ import {
 	tsonUnknownObjectGuard,
 } from "tupleson";
 
-const json = createTupleson({
+const tson = createTson({
 	// 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",
@@ -62,7 +63,7 @@ const json = createTupleson({
 	],
 });
 
-const result = json.stringify(
+const result = tson.stringify(
 	{
 		foo: "bar",
 		set: new Set([1, 2, 3]),

src/handlers/tsonBigint.test.ts

@@ -1,12 +1,12 @@
 import { expect, test } from "vitest";
 
-import { createTupleson } from "../tson.js";
+import { createTson } from "../tson.js";
 import { tsonBigint } from "./tsonBigint.js";
 import { tsonMap } from "./tsonMap.js";
 import { tsonSet } from "./tsonSet.js";
 
 test("bigint", () => {
-	const t = createTupleson({
+	const t = createTson({
 		types: [tsonMap, tsonSet, tsonBigint],
 	});
 

src/handlers/tsonDate.test.ts

@@ -1,10 +1,10 @@
 import { expect, test } from "vitest";
 
-import { createTupleson } from "../tson.js";
+import { createTson } from "../tson.js";
 import { tsonDate } from "./tsonDate.js";
 
 test("Date", () => {
-	const ctx = createTupleson({
+	const ctx = createTson({
 		types: [tsonDate],
 	});
 

src/handlers/tsonMap.test.ts

@@ -1,10 +1,10 @@
 import { expect, test } from "vitest";
 
-import { createTupleson } from "../tson.js";
+import { createTson } from "../tson.js";
 import { tsonMap } from "./tsonMap.js";
 
 test("Map", () => {
-	const t = createTupleson({
+	const t = createTson({
 		types: [tsonMap],
 	});
 

src/handlers/tsonNumberGuard.test.ts

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

src/handlers/tsonRegExp.test.ts

@@ -1,10 +1,10 @@
 import { expect, test } from "vitest";
 
-import { createTupleson } from "../tson.js";
+import { createTson } from "../tson.js";
 import { tsonRegExp } from "./index.js";
 
 test("regex", () => {
-	const t = createTupleson({
+	const t = createTson({
 		types: [tsonRegExp],
 	});
 

src/handlers/tsonSet.test.ts

@@ -1,10 +1,10 @@
 import { expect, test } from "vitest";
 
-import { createTupleson } from "../tson.js";
+import { createTson } from "../tson.js";
 import { tsonSet } from "./tsonSet.js";
 
 test("Set", () => {
-	const t = createTupleson({
+	const t = createTson({
 		types: [tsonSet],
 	});
 

src/handlers/tsonURL.test.ts

@@ -1,10 +1,10 @@
 import { expect, test } from "vitest";
 
-import { createTupleson } from "../tson.js";
+import { createTson } from "../tson.js";
 import { tsonURL } from "./tsonURL.js";
 
 test("URL", () => {
-	const ctx = createTupleson({
+	const ctx = createTson({
 		types: [tsonURL],
 	});
 

src/handlers/tsonUndefined.test.ts

@@ -1,10 +1,10 @@
 import { expect, test } from "vitest";
 
-import { createTupleson } from "../tson.js";
+import { createTson } from "../tson.js";
 import { tsonUndefined } from "./tsonUndefined.js";
 
 test("undefined", () => {
-	const ctx = createTupleson({
+	const ctx = createTson({
 		types: [tsonUndefined],
 	});
 

src/handlers/tsonUnknownObjectGuard.test.ts

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

src/index.ts

@@ -1,9 +1,9 @@
 export {
-	createTupleson,
-	tsonDeserializer,
-	tsonParser,
-	tsonSerializer,
-	tsonStringifier,
+	createTson,
+	createTsonDeserialize,
+	createTsonParser,
+	createTsonSerialize,
+	createTsonStringify,
 } from "./tson.js";
 
 export * from "./handlers/index.js";

src/stringify.test.ts

@@ -4,10 +4,10 @@ import { tsonBigint } from "./handlers/tsonBigint.js";
 import { tsonMap } from "./handlers/tsonMap.js";
 import { tsonSet } from "./handlers/tsonSet.js";
 import { tsonUndefined } from "./handlers/tsonUndefined.js";
-import { createTupleson } from "./tson.js";
+import { createTson } from "./tson.js";
 
 test("lets have a look at the stringified output", () => {
-	const t = createTupleson({
+	const t = createTson({
 		types: [tsonMap, tsonSet, tsonBigint, tsonUndefined],
 	});
 

src/tson.ts

@@ -28,7 +28,7 @@ type WalkerFactory = (nonce: TsonNonce) => WalkFn;
 type AnyTsonTransformerSerializeDeserialize =
 	TsonTransformerSerializeDeserialize<any, any>;
 
-export function tsonDeserializer(opts: TsonOptions): TsonDeserializeFn {
+export function createTsonDeserialize(opts: TsonOptions): TsonDeserializeFn {
 	const typeByKey: Record<string, AnyTsonTransformerSerializeDeserialize> = {};
 
 	for (const handler of opts.types) {
@@ -61,21 +61,21 @@ export function tsonDeserializer(opts: TsonOptions): TsonDeserializeFn {
 		walker(obj.nonce)(obj.json)) as TsonDeserializeFn;
 }
 
-export function tsonParser(opts: TsonOptions): TsonParseFn {
-	const deserializer = tsonDeserializer(opts);
+export function createTsonParser(opts: TsonOptions): TsonParseFn {
+	const deserializer = createTsonDeserialize(opts);
 
 	return ((str: string) =>
 		deserializer(JSON.parse(str) as TsonSerialized)) as TsonParseFn;
 }
 
-export function tsonStringifier(opts: TsonOptions): TsonStringifyFn {
-	const serializer = tsonSerializer(opts);
+export function createTsonStringify(opts: TsonOptions): TsonStringifyFn {
+	const serializer = createTsonSerialize(opts);
 
 	return ((obj: unknown, space?: number | string) =>
 		JSON.stringify(serializer(obj), null, space)) as TsonStringifyFn;
 }
 
-export function tsonSerializer(opts: TsonOptions): TsonSerializeFn {
+export function createTsonSerialize(opts: TsonOptions): TsonSerializeFn {
 	const handlers = (() => {
 		const types = opts.types.map((handler) => {
 			type Serializer = (
@@ -186,9 +186,9 @@ function mapOrReturn(
 	return input;
 }
 
-export const createTupleson = (opts: TsonOptions) => ({
-	deserialize: tsonDeserializer(opts),
-	parse: tsonParser(opts),
-	serialize: tsonSerializer(opts),
-	stringify: tsonStringifier(opts),
+export const createTson = (opts: TsonOptions) => ({
+	deserialize: createTsonDeserialize(opts),
+	parse: createTsonParser(opts),
+	serialize: createTsonSerialize(opts),
+	stringify: createTsonStringify(opts),
 });

src/types.test.ts

@@ -1,10 +1,10 @@
 import { expectTypeOf, test } from "vitest";
 
 import { tsonBigint } from "./handlers/tsonBigint.js";
-import { createTupleson } from "./tson.js";
+import { createTson } from "./tson.js";
 
 test("types", () => {
-	const t = createTupleson({
+	const t = createTson({
 		types: [tsonBigint],
 	});