microsoft / microsoft/TypeScript
[PROPOSAL] Support @augments/@extends attached to an Object types
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Go
- Estrellas
- 111k
- Forks
- 14.3k
- Merge medio
- 1 d 19 h
- PR fusionados (30 d)
- 117
Descripción
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.
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
No se nombran archivos fuente ni pruebas. Empieza reproduciendo el ejemplo de JavaScript proporcionado con tsc y siguiendo cómo se gestionan JSDoc @augments/@extends para typedefs; se considera terminado cuando los object typedefs aceptan estas etiquetas sin el diagnóstico indicado y producen el tipo combinado previsto.
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
- Nueva funcionalidad
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Necesita aclaración
- Aptitud para principiantes
- 25/100