microsoft / microsoft/TypeScript

A way to express that a method must be overriden

Ouverte
#43,910 2 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

Suggestion

In Javascript it is possible and encouraged in documentations like MDN to override toString and valueOf for custom objects, because the version inherited from Object is not very useful (the dreaded [object Object]).

However, there is to my knowledge no way to express in a type that a class must override those methods (or that an object must have them as own properties) and therefore no way to know if they are reliable.

🔍 Search Terms

method overriding, toString, own property

✅ Viability Checklist

My suggestion meets these guidelines:

  • This wouldn't be a breaking change in existing TypeScript/JavaScript code
  • This wouldn't change the runtime behavior of existing JavaScript code
  • This could be implemented without emitting different JS based on the types of the expressions
  • This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, new syntax sugar for JS, etc.)
  • This feature would agree with the rest of TypeScript's Design Goals.

⭐ Suggestion

An idea would be to have a own modifier which would basically compare a property name with the list produced by the following function

const ownModifierList = (obj) => {
  const isObjectLiteral = obj.constructor.name === "Object";
  const toList = isObjectLiteral ? obj : obj.constructor.prototype;
  return Object.getOwnPropertyNames(toList).filter(x => x !== 'constructor')
}

I think it reads well:

type showable = {
   own toString: () => string
}

📃 Motivating Example

Having a useless toString is borderline a Liskov substitution violation and Javascript users have learned to not rely on it. Typescript could come to the rescue.

The modifier would also make it easy to reject Object.create(null).

I have been reading some Haskell lately and I was envious of the confidence the type class Show gives haskellers, but it is built in. Javascript uses toString for type coercion and I believe it makes more sense to try to achieve that level of confidence by fixing it.

I don't know in what other circumstances one would require that a method is overridden as it would indicate that the base class's method is not suitable, which would be a red flag, but my lack of imagination is no proof that it can't be useful in other situations.

💻 Use Cases

Having a polymorphic way to query a string from an object.

Currently one would need to implement a custom method or signify by some tag that toString is safe to use, and the user of the object would need to know about this tag/custom method.

We can imagine generic functions like a sorting function which default to converting an object to a string in order to deal with it, but only if it is a usable string. The IDE would advertise by the function definition in the tooltip that it is possible to pass an object as long as it implements toString, which would make the user happy as it would potentially clean up some code in many places.

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 le modificateur own proposé et ses exemples pour toString et valueOf ; l’issue ne mentionne aucun fichier d’implémentation, test ou point d’entrée. Déterminez le comportement attendu du système de types, notamment pour les propriétés propres et Object.create(null), et définissez des tests montrant quand l’exigence est acceptée ou rejetée.

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

Évaluation

Stack technique
javascript, typescript
Domaine
compilers
Type d'issue
Fonctionnalité
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

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