microsoft / microsoft/TypeScript
All types of ECMAScript NativeErrors are always subtype reduced between themselves
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Go
- Estrellas
- 111k
- Forks
- 14.3k
- Merge medio
- 2 d 4 h
- PR fusionados (30 d)
- 132
Descripción
⚙ Compilation target
ESNext
⚙ Library
es5
Missing / Incorrect Definition
All error instance types defined in es5 are equivalent in eyes of TypeScript, but are distinguishable at runtime with instanceof.
Here is how each error is defined right now:
interface XError extends Error { // <- Same as Error!
}
interface XErrorConstructor extends ErrorConstructor {
new (message?: string): XError
(message?: string): XError
readonly prototype: XError
}
declare var XError: XErrorConstructor
As you can see, any error is structurally equivalent to another, including Error itself. This makes the issue propagate to error constructors as well.
On a somewhat related note, child classes of Error (class MyError extends Error {}) do not have this issue.
This affects libraries that attempt making error-handling typed (for example, Effect.ts, NeverThrow 🙅, etc.), making them unreliable when using built-in errors. (Which are, arguably, the most commonly used type of errors.)
Sample Code
// Should be (SyntaxError | TypeError)[]
const twoErrors0 /* <? SyntaxError[] */ = [
new SyntaxError(),
new TypeError(),
]
// Should be (TypeError | SyntaxError)[]
const twoErrors1 /* <? TypeError[] */ = [
new TypeError(),
new SyntaxError(),
]
// --------------------------------------------------------------------
// Should return RangeError | URIError
function makeError0(flag: boolean) /* : RangeError is inferred */ {
if (flag)
return new RangeError()
return new URIError()
}
// Should return URIError | RangeError
function makeError1(flag: boolean) /* : URIError is inferred */ {
if (flag)
return new URIError()
return new RangeError()
}
const madeError = makeError1(true)
if (madeError instanceof URIError) {
// handle URIError
} else {
console.log(madeError)
// ^? madeError: never
// Programmer thinks they handled all cases, because the error is of type never here.
// madeError is actually an instance of RangeError at runtime.
// This happened due to TypeScript wrongly inferring makeError1's return type.
}
Documentation Link
ECMAScript 5.1: 15.11.7 NativeError Object Structure
ECMAScript 5.1: 15.3.5.3 [[HasInstance]] (V)
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza con las declaraciones de ES5 NativeError y los casos de ejemplo de inferencia de tipos del issue. Comprueba cómo las declaraciones actuales hacen que los tipos de error integrados sean estructuralmente equivalentes y cómo la reducción de subtipos gestiona sus constructores. Se considera completado cuando los tipos de error nativos siguen siendo distinguibles en los ejemplos mostrados de arrays y tipos de retorno, con cobertura de regresión para esos casos.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- javascript, typescript
- Área
- compilers
- Tipo de issue
- Error
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100