Fix type of base argument create error

[jessta]

This PR fixes the type of the Base argument to createError.

The previous type was Error which is the type of an Error value, but it's being used is as a constructor for a class that inherits from Error.

This change makes the type of Base a constructor for a class that inherits from Error so it's type matches it's usage and documented examples.

Checklist

• run npm run test and npm run benchmark
• tests and/or benchmarks are included
• documentation is changed or added
• commit message and code follows the Developer's Certification of Origin
  and the Code of conduct

[climba03003]

Please use ErrorConstructor if you really means to be a constructor.

[jessta]

Please use ErrorConstructor if you really means to be a constructor.

new () => Error is a subset of ErrorConstructor and provides all the functionality required by createError().
It doesn't seem necessary to also require that these classes are also callable as functions.

I'd like to be able to use this with classes that inherit from Error, which aren't callable as functions like ErrorConstructor requires.
eg.
class MyError extends Error {}

[jsumners]

I'm having difficulty following the reasoning for this PR, but it sounds like a misunderstanding of Error. The implementation here follows the specification:

https://262.ecma-international.org/13.0/#sec-error-objects

creates and initializes a new Error object when called as a function rather than as a constructor. Thus the function call Error(…) is equivalent to the object creation expression new Error(…) with the same arguments.

[jessta]

@jsumners The value Error has the type ErrorConstructor, you can call Error as a function eg. Error("some string") or using new Error("some string") and you''ll get a value of type Error.

The current types defined for createError only allow you to pass a value of type Error as the Base parameter, but the function only works if you pass a value of ErrorConstructor. In fact ,the default value assigned to Base is Error which has the type ErrorConstructor.

This PR makes it possible to call createError('CODE', 'hey %s', 500, Error) from Typescript, without this change you can only call createError('CODE', 'hey %s', 500, Error("some string")) which results in a runtime error.

Without this change it's not possible to call createError() correctly from Typescript.

[jsumners]

ping: @fastify/typescript

[Uzlopak]

The finding is correct, it should not be Error.

We have this issue also in fastify

I would prefer ErrorConstructor. If you are using typescript wouldnt you use a class anyway?

[climba03003]

ErrorConstructor is a proper Error structure for JavaScript.
And it also required to provide the function creation method.

interface ErrorConstructor {
    new(message?: string): Error;
    (message?: string): Error;
    readonly prototype: Error;
}

But, I still in favor of using ErrorConstructor as it is more predictable in the structure and follow the spec.

[fox1t]

As @Uzlopak said, this is a TS definition issue. Thanks for finding and fixing it, @jessta!
I agree with @climba03003, and I would prefer ErrorConstructor to be used here since it is more flexible and usable by Object.create(.
@jessta I am trying to understand why you would prefer to have only a strict constructor here.

[jessta]

I've updated the types to be ErrorConstructor since that seems to be the consensus.

[Uzlopak]

LGTM

[github-actions]

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.