microsoft / microsoft/TypeScript

[PROPOSAL] Support @augments/@extends attached to an Object types

Aperta
#40,071 1 commento 3 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Awaiting More Feedback Suggestion
Lingua principale
Go
Stelle
111k
Fork
14.3k
Merge medio
2g 4h
PR unite (30g)
132

Descrizione

Search Terms

jsdoc extends object

Suggestion

Support @augments/@extends attached to an Object types.

Actually, *Storm IDEs are following it, on intellisense but tsc complains by

JSDoc '@augments' is not attached to a class.

Use Cases

Provide a way to type the derivating (merged) result of any objects to a single one.

Examples

    /**
     * @typedef Obj
     * @type {Object}
     */
    
    /**
     * @typedef Properties
     * @type {Object}
     */
    
    /**
     * @typedef Return
     * @type {Object}
     * @augments Obj
     * @augments Properties
     */
    
    /**
     * @type {Obj} obj
     */
    const obj = {
      /**
       * @param {Properties} [properties]
       * @returns {Return}
       */
      derivate ({ ...properties } = {}) {
        return { ...this, ...properties }
      }
    }

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, etc.)

  • This feature would agree with the rest of TypeScript's Design Goals.

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Non sono indicati file sorgente o test. Inizia riproducendo l'esempio JavaScript fornito con tsc e tracciando come vengono gestiti JSDoc @augments/@extends per i typedefs; il lavoro è completo quando gli object typedefs accettano questi tag senza la diagnostica segnalata e producono il tipo unito previsto.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
javascript, typescript
Ambito
compilers
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.