Support serialization of URL #200

package.json

@@ -58,6 +58,7 @@
   "devDependencies": {
     "@types/debug": "^4.1.5",
     "@types/mongodb": "^3.6.12",
+    "@types/node": "^18.7.18",
     "benchmark": "^2.1.4",
     "decimal.js": "^10.3.1",
     "eslint-plugin-es5": "^1.5.0",

src/index.test.ts

@@ -633,6 +633,22 @@ describe('stringify & parse', () => {
         expect(value.pet.woof()).toEqual('Rover');
       },
     },
+    'works with URL': {
+      input: {
+        a: new URL('https://example.com/'),
+        b: new URL('https://github.com/blitz-js/superjson'),
+      },
+      output: {
+        a: 'https://example.com/',
+        b: 'https://github.com/blitz-js/superjson',
+      },
+      outputAnnotations: {
+        values: {
+          a: ['URL'],
+          b: ['URL'],
+        },
+      },
+    },
   };
 
   function deepFreeze(object: any, alreadySeenObjects = new Set()) {

src/is.test.ts

@@ -11,6 +11,7 @@ import {
   isUndefined,
   isPlainObject,
   isTypedArray,
+  isURL,
 } from './is';
 
 test('Basic true tests', () => {
@@ -31,6 +32,7 @@ test('Basic true tests', () => {
   expect(isDate(new Date())).toBe(true);
   expect(isSymbol(Symbol())).toBe(true);
   expect(isTypedArray(new Uint8Array())).toBe(true);
+  expect(isURL(new URL('https://example.com'))).toBe(true);
 });
 
 test('Basic false tests', () => {
@@ -48,6 +50,8 @@ test('Basic false tests', () => {
   expect(isSymbol(NaN)).toBe(false);
 
   expect(isTypedArray([])).toBe(false);
+
+  expect(isURL('https://example.com')).toBe(false);
 });
 
 test('Primitive tests', () => {

src/is.ts

@@ -85,3 +85,5 @@ export type TypedArray = InstanceType<TypedArrayConstructor>;
 
 export const isTypedArray = (payload: any): payload is TypedArray =>
   ArrayBuffer.isView(payload) && !(payload instanceof DataView);
+
+export const isURL = (payload: any): payload is URL => payload instanceof URL;

src/transformer.ts

@@ -12,6 +12,7 @@ import {
   isError,
   isTypedArray,
   TypedArrayConstructor,
+  isURL,
 } from './is';
 import { ClassRegistry } from './class-registry';
 import { SymbolRegistry } from './symbol-registry';
@@ -21,7 +22,12 @@ import { findArr } from './util';
 
 export type PrimitiveTypeAnnotation = 'number' | 'undefined' | 'bigint';
 
-type LeafTypeAnnotation = PrimitiveTypeAnnotation | 'regexp' | 'Date' | 'Error';
+type LeafTypeAnnotation =
+  | PrimitiveTypeAnnotation
+  | 'regexp'
+  | 'Date'
+  | 'Error'
+  | 'URL';
 
 type TypedArrayAnnotation = ['typed-array', string];
 type ClassTypeAnnotation = ['class', string];
@@ -159,6 +165,13 @@ const simpleRules = [
     },
     Number
   ),
+
+  simpleTransformation(
+    isURL,
+    'URL',
+    v => v.toString(),
+    v => new URL(v)
+  ),
 ];
 
 function compositeTransformation<I, O, A extends CompositeTypeAnnotation>(