chore: add nodejs inspect to explain correct properties (#10)

x-spacy · Jan 2, 2024 · 968e1db · 968e1db
1 parent b3beda1
commit 968e1db
Show file tree

Hide file tree

Showing 13 changed files with 202 additions and 0 deletions.
diff --git a/src/data/Body.ts b/src/data/Body.ts
@@ -16,4 +16,8 @@ export class Body {
 
     return record;
   }
+
+  [Symbol.for('nodejs.util.inspect.custom')](): Record<string, unknown> {
+    return this.toJSON();
+  }
 }
diff --git a/src/data/Contact.ts b/src/data/Contact.ts
@@ -69,6 +69,44 @@ export class Contact {
   public get urls(): ContactUrl | undefined {
     return this.#urls;
   }
+
+  public toJSON(): Record<string, unknown> {
+    const record: Record<string, unknown> = {};
+
+    if (this.#addresses) {
+      record['addresses'] = this.#addresses;
+    }
+
+    if (this.#birthday) {
+      record['birthday'] = this.#birthday;
+    }
+
+    if (this.#emails) {
+      record['emails'] = this.#emails;
+    }
+
+    if (this.#name) {
+      record['name'] = this.#name;
+    }
+
+    if (this.#org) {
+      record['org'] = this.#org;
+    }
+
+    if (this.#phones) {
+      record['phones'] = this.#phones;
+    }
+
+    if (this.#urls) {
+      record['urls'] = this.#urls;
+    }
+
+    return record;
+  }
+
+  [Symbol.for('nodejs.util.inspect.custom')](): Record<string, unknown> {
+    return this.toJSON();
+  }
 }
 
 export class ContactAddress {
@@ -169,6 +207,10 @@ export class ContactAddress {
 
     return record;
   }
+
+  [Symbol.for('nodejs.util.inspect.custom')](): Record<string, unknown> {
+    return this.toJSON();
+  }
 }
 
 export class ContactEmail {
@@ -204,6 +246,10 @@ export class ContactEmail {
 
     return record;
   }
+
+  [Symbol.for('nodejs.util.inspect.custom')](): Record<string, unknown> {
+    return this.toJSON();
+  }
 }
 
 export class ContactName {
@@ -289,6 +335,10 @@ export class ContactName {
 
     return record;
   }
+
+  [Symbol.for('nodejs.util.inspect.custom')](): Record<string, unknown> {
+    return this.toJSON();
+  }
 }
 
 export class ContactOrg {
@@ -337,6 +387,10 @@ export class ContactOrg {
 
     return record;
   }
+
+  [Symbol.for('nodejs.util.inspect.custom')](): Record<string, unknown> {
+    return this.toJSON();
+  }
 }
 
 export class ContactPhone {
@@ -385,6 +439,10 @@ export class ContactPhone {
 
     return record;
   }
+
+  [Symbol.for('nodejs.util.inspect.custom')](): Record<string, unknown> {
+    return this.toJSON();
+  }
 }
 
 export class ContactUrl {
@@ -420,4 +478,8 @@ export class ContactUrl {
 
     return record;
   }
+
+  [Symbol.for('nodejs.util.inspect.custom')](): Record<string, unknown> {
+    return this.toJSON();
+  }
 }
diff --git a/src/data/Context.ts b/src/data/Context.ts
@@ -16,4 +16,8 @@ export class Context {
 
     return record;
   }
+
+  [Symbol.for('nodejs.util.inspect.custom')](): Record<string, unknown> {
+    return this.toJSON();
+  }
 }
diff --git a/src/data/Currency.ts b/src/data/Currency.ts
@@ -26,4 +26,8 @@ export class Currency {
 
     return record;
   }
+
+  [Symbol.for('nodejs.util.inspect.custom')](): Record<string, unknown> {
+    return this.toJSON();
+  }
 }
diff --git a/src/data/DateTime.ts b/src/data/DateTime.ts
@@ -33,6 +33,10 @@ export class DateTime {
 
     return record;
   }
+
+  [Symbol.for('nodejs.util.inspect.custom')](): Record<string, unknown> {
+    return this.toJSON();
+  }
 }
 
 export class DateTimeComponent {
@@ -125,6 +129,10 @@ export class DateTimeComponent {
 
     return record;
   }
+
+  [Symbol.for('nodejs.util.inspect.custom')](): Record<string, unknown> {
+    return this.toJSON();
+  }
 }
 
 export class DateTimeEpoch {
@@ -145,4 +153,8 @@ export class DateTimeEpoch {
 
     return record;
   }
+
+  [Symbol.for('nodejs.util.inspect.custom')](): Record<string, unknown> {
+    return this.toJSON();
+  }
 }
diff --git a/src/data/Footer.ts b/src/data/Footer.ts
@@ -16,4 +16,8 @@ export class Footer {
 
     return record;
   }
+
+  [Symbol.for('nodejs.util.inspect.custom')](): Record<string, unknown> {
+    return this.toJSON();
+  }
 }
diff --git a/src/data/Header.ts b/src/data/Header.ts
@@ -70,6 +70,10 @@ export class Header {
 
     return record;
   }
+
+  [Symbol.for('nodejs.util.inspect.custom')](): Record<string, unknown> {
+    return this.toJSON();
+  }
 }
 
 export class HeaderProvider {
@@ -90,6 +94,10 @@ export class HeaderProvider {
 
     return record;
   }
+
+  [Symbol.for('nodejs.util.inspect.custom')](): Record<string, unknown> {
+    return this.toJSON();
+  }
 }
 
 export class HeaderImage {
@@ -140,6 +148,10 @@ export class HeaderImage {
 
     return record;
   }
+
+  [Symbol.for('nodejs.util.inspect.custom')](): Record<string, unknown> {
+    return this.toJSON();
+  }
 }
 
 export class HeaderVideo {
@@ -190,6 +202,10 @@ export class HeaderVideo {
 
     return record;
   }
+
+  [Symbol.for('nodejs.util.inspect.custom')](): Record<string, unknown> {
+    return this.toJSON();
+  }
 }
 
 export class HeaderDocument {
@@ -253,4 +269,8 @@ export class HeaderDocument {
 
     return record;
   }
+
+  [Symbol.for('nodejs.util.inspect.custom')](): Record<string, unknown> {
+    return this.toJSON();
+  }
 }