Use a distinct type for an Error that was constructed with a cause

[davidhousedev]

Within our organization, we've encountered challenges when developers log an Error that does not have a cause defined. When a cause is provided, it's much easier to trace back the reason why an exception occurred in production.

Given that causes have proven so useful to us, we're extending the ErrorConstructor with new overloads that will return a structurally-distinct type when cause is provided, ErrorWithCause. This new type cannot be constructed directly (through the use of a private constructor) which is a good thing because there is no JS implementation.

Here's how we've extended our reset.d.ts files locally in order to accomplish this:

declare global {
  declare class ErrorWithCause {
    message: string
    stack: string
    name: string
    private errorWithCause: true
    private constructor(message: string, options: { cause: unknown })
  }
  interface ErrorConstructor {
    new(message: string): Error
    new(message: string, options: { cause: unknown }): ErrorWithCause
    (message?: string): Error
    (message: string, options: { cause: unknown }): ErrorWithCause
  }
}

Would this be a useful addition to ts-reset? Based on what I can tell, there might be some complexity around the target if the JS is being run in an environment that doesn't support cause on Error.