microsoft / microsoft/TypeScript

All types of ECMAScript NativeErrors are always subtype reduced between themselves

Ouverte
#62,134 6 commentaires 1 réaction 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Awaiting More Feedback Suggestion
Langage dominant
Go
Étoiles
111k
Forks
14.3k
Merge moyen
2 j 4 h
PR mergées (30 j)
132

Description

⚙ 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)

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par les déclarations ES5 NativeError et les cas d’exemple d’inférence de types dans l’issue. Vérifiez comment les déclarations actuelles rendent les types d’erreur intégrés structurellement équivalents et comment la réduction des sous-types traite leurs constructeurs. Le travail est terminé lorsque les types d’erreur natifs restent distinguables dans les exemples montrés de tableaux et de types de retour, avec une couverture de régression pour ces cas.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
javascript, typescript
Domaine
compilers
Type d'issue
Bug
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.