Add info about cause explicitly always being undefined (#124)

* Add info about `cause` explicitly always being `undefined` * Update index.d.ts Co-authored-by: Pelle Wessman <pelle@kodfabrik.se> * Update index.d.ts --------- Co-authored-by: Pelle Wessman <pelle@kodfabrik.se>
pinojs · May 3, 2023 · 3feb29b · 3feb29b
1 parent 986ef19
commit 3feb29b
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -24,6 +24,10 @@ export interface SerializedError {
    * This is available for subsequent serializers to use.
    */
   raw: Error;
+  /**
+   * `cause` is never included in the log output, if you need the `cause`, use {@link raw.cause}
+   */
+  cause?: never;
   /**
    * Any other extra properties that have been attached to the object will also be present on the serialized object.
    */