microsoft / microsoft/TypeScript

Property decorator documentation is inaccurate?

Abierto
#32,395 8 comentarios 9 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Docs
Lenguaje dominante
Go
Estrellas
111k
Forks
14.4k
Merge medio
1 d 19 h
PR fusionados (30 d)
117

Descripción

From the official docs about property decorators:

"The return value is ignored too."

But the following example returns a new descriptor, and it works fine:

class Greeter {
  @logProperty
  greeting;
}

function logProperty(target, key): any {
    var value;

    var getter = function() {
      console.log('getter');
      return value;
    };

    var setter = function(newVal) {
      value = newVal;
    };

    return {
      get: getter,
      set: setter,
      enumerable: true,
      configurable: true
    };
}

const g = new Greeter();
const b = g.greeting;

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza por la sección Property Decorators de la documentación oficial de decoradores de TypeScript enlazada en el issue; después, verifica el ejemplo de decorador de propiedades mostrado y el comportamiento del descriptor que devuelve. Actualiza la documentación para que la afirmación sobre los valores de retorno ignorados coincida exactamente con el ejemplo documentado y el comportamiento observado.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
javascript, typescript
Área
documentation
Tipo de issue
Documentación
Dificultad
2/5
Tiempo estimado
1-3 horas
Estado de actividad
Estancado
Claridad
Bien especificado
Aptitud para principiantes
45/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.