La idea
Un decorator es una función que se aplica a una clase o a uno de sus miembros con @nombre. Recibe lo que decora y puede devolver un reemplazo:
class Pedido {
@registrar
confirmar(id) {
return `pedido ${id} confirmado`;
}
}
Es una forma declarativa de escribir algo que ya sabes hacer: envolver una función con otra, como en Funciones como valores. Sin la sintaxis nueva, sería:
function registrar(metodo) {
return function (...args) {
console.log(`llamando con ${args.join(", ")}`);
return metodo.apply(this, args);
};
}
class Pedido {
confirmar(id) {
return `pedido ${id} confirmado`;
}
}
Pedido.prototype.confirmar = registrar(Pedido.prototype.confirmar);
console.log(new Pedido().confirmar(7));
Cómo se escribe uno
En la propuesta actual, un decorator recibe dos argumentos: el valor decorado (el método, la clase, el campo…) y un objeto contexto con información sobre él:
function soloLectura(valor, contexto) {
// contexto.kind: "method", "field", "class", "getter", "setter", "accessor"
// contexto.name: el nombre del miembro
if (contexto.kind === "field") {
return function (inicial) {
return Object.freeze(inicial);
};
}
}
class Ajustes {
@soloLectura
colores = { fondo: "negro" };
}
Para un método, devolver una función la reemplaza; para un campo, devolver una función transforma su valor inicial. Si no devuelve nada, el miembro queda como estaba.
La propuesta también agrega accessor, una palabra clave para crear un getter y un setter automáticos que los decorators pueden interceptar:
class Formulario {
@validarEmail
accessor email = "";
}
Dos versiones: la antigua y la de la propuesta
Los frameworks que usan decorators desde hace años (Angular, NestJS, TypeORM) nacieron con una versión antigua, que TypeScript activa con experimentalDecorators: true. Tiene otra firma: recibe el prototipo, el nombre y un descriptor de la propiedad.
Desde TypeScript 5.0, sin esa opción, se usan los decorators de la propuesta actual, los de esta lección. Si empiezas un proyecto nuevo, usa estos. Si trabajas con un framework que pide la versión antigua, sigue su documentación.
Resumen
- Un decorator es una función aplicada con
@nombrea una clase o a sus miembros. - Recibe el valor decorado y un contexto (
kind,name…), y puede devolver un reemplazo. - Está en Stage 2.7: hoy se usa con TypeScript o Babel.
experimentalDecoratorsde TypeScript es la versión antigua; la de la propuesta es la recomendada para proyectos nuevos.- Sin herramientas, consigues lo mismo envolviendo el método con una función de orden superior.
¡A practicar!
Tu progreso se guarda en este navegador.
Autoevaluación: Funciones que envuelven clases
Resuelto
Elige una respuesta en cada pregunta.
¿Qué es un decorator?
¿En qué estado están los decorators en JavaScript?
Los decorators de
experimentalDecoratorsde TypeScript, ¿son iguales a los de la propuesta?Sin decorators, ¿cómo consigues lo mismo hoy?
Ordena la salida: Un método envuelto
Resuelto
Imagina este código compilado con TypeScript. Ordena lo que aparecería en la consola al ejecutarlo.
1function registrar(metodo, contexto) {2 return function (...args) {3 console.log(`→ ${contexto.name}(${args.join(", ")})`);4 const resultado = metodo.apply(this, args);5 console.log(`← ${resultado}`);6 return resultado;7 };8}9 10class Calculadora {11 @registrar12 sumar(a, b) {13 return a + b;14 }15}16 17console.log("total:", new Calculadora().sumar(2, 3));Consola, de arriba abajo
- total: 5
- → sumar(2, 3)
- ← 5
@registrar reemplaza sumar por la función que devuelve registrar. Al llamarla, imprime la entrada, ejecuta el método original, imprime la salida y devuelve el resultado, que recién entonces llega al console.log de afuera. (Este código necesita TypeScript o Babel para ejecutarse.)
Detective: Un decorator en el navegador
Resuelto
Este archivo funciona en un proyecto con TypeScript, pero alguien lo abrió directamente en el navegador. Encuentra la línea y elige el arreglo que funciona hoy, sin herramientas.
Consola
servicio.js:6 @registrar ^ SyntaxError: Invalid or unexpected token
Paso 1: toca la línea de código que causa el error.
Paso 2: ¿cómo lo arreglas?
Laboratorio: Un decorator sin @
Resuelto
Escribe registrar(fn): un decorator “a mano” que envuelve una función para imprimir sus argumentos.
$ node programa.js
Lo que debe cumplir
- Imprime
llamada con: 2, 3y después5(pendiente) - Devuelve el resultado de cualquier función envuelta (pendiente)
- No ejecuta
fnhasta que se llama a la función envuelta (pendiente)
Una solución
1function registrar(fn) {2 return function (...args) {3 console.log("llamada con: " + args.join(", "));4 return fn(...args);5 };6}7 8const sumar = (a, b) => a + b;9const sumarConRegistro = registrar(sumar);10 11console.log(sumarConRegistro(2, 3));Acabas de escribir un decorator: una función que envuelve a otra y le agrega comportamiento sin cambiar su código. Cuando la propuesta termine, podrás aplicarlo a un método con @registrar; hoy se aplica a mano, como en esta línea: registrar(sumar).