refactor: improve ts for toString

Signed-off-by: Grant Timmerman <[email protected]>

Author: grant

src/event/cloudevent.ts

@@ -198,9 +198,9 @@ See: https://github.com/cloudevents/spec/blob/v1.0/spec.md#type-system`);
 
   /**
    * The native `console.log` value of the CloudEvent.
-   * @return The string representation of the CloudEvent.
+   * @return {string} The string representation of the CloudEvent.
    */
-  [Symbol.for("nodejs.util.inspect.custom")]() {
+  [Symbol.for("nodejs.util.inspect.custom")](): string {
     return this.toString();
   }
 }

test/integration/cloud_event_test.ts

@@ -57,7 +57,9 @@ describe("A CloudEvent", () => {
 
   it("serializes as JSON with raw log", () => {
     const ce = new CloudEvent({ ...fixture, data: { lunch: "tacos" } });
-    expect(ce.toString()).to.deep.equal(JSON.stringify(ce));
+    const inspectSymbol = (Symbol.for("nodejs.util.inspect.custom") as unknown) as string;
+    const ceToString = (ce[inspectSymbol] as CallableFunction).bind(ce);
+    expect(ce.toString()).to.deep.equal(ceToString());
   });
 
   it("Throw a validation error for invalid extension names", () => {