Crear un símbolo
Un símbolo se crea llamando a Symbol(), sin new. Puedes darle una descripción, que solo sirve para reconocerlo al depurar:
const id = Symbol("id");
console.log(typeof id); // symbol
console.log(id.description); // id
console.log(id.toString()); // Symbol(id)
Lo que lo hace especial es que cada símbolo es único. Dos símbolos con la misma descripción siguen siendo distintos:
console.log(Symbol("id") === Symbol("id")); // false
Símbolos como claves de propiedad
El uso principal de un símbolo es servir de clave en un objeto. Se escribe entre corchetes:
const visto = Symbol("visto");
const articulo = {
titulo: "Aprende JS",
[visto]: true,
};
console.log(articulo[visto]); // true
console.log(Object.keys(articulo)); // [ 'titulo' ]
console.log(JSON.stringify(articulo)); // {"titulo":"Aprende JS"}
Una propiedad con clave símbolo tiene dos ventajas:
- No choca con ninguna otra: aunque el objeto tenga otra propiedad llamada
visto, tu símbolo es otra clave. - No aparece en
Object.keys, en los buclesfor…inni enJSON.stringify. El objeto se ve y se guarda igual que antes.
Por eso las librerías los usan para guardar datos propios en objetos que no les pertenecen, sin riesgo de pisar nada.
El registro global: Symbol.for
A veces quieres que distintas partes del programa compartan el mismo símbolo. Para eso existe un registro global: Symbol.for(clave) busca un símbolo con esa clave y, si no existe, lo crea:
const a = Symbol.for("app.usuario");
const b = Symbol.for("app.usuario");
console.log(a === b); // true: es el mismo
console.log(Symbol.keyFor(a)); // app.usuario
Usa una clave con un prefijo propio, como "app.", para no coincidir con el registro de otra librería.
Los símbolos que usa el propio lenguaje
JavaScript define varios símbolos conocidos (well-known symbols) que le permiten a tus objetos engancharse a comportamientos del lenguaje. El más famoso es Symbol.iterator: si un objeto tiene un método con esa clave, se puede recorrer con for…of.
console.log(typeof Symbol.iterator); // symbol
console.log(typeof "hola"[Symbol.iterator]); // function: los strings son recorribles
Los vas a usar en las secciones de Iteradores y generadores y Metaprogramación. Por ahora basta con saber que existen y que son símbolos.
Resumen
Symbol("descripción")crea un valor único, sinnew. Dos símbolos nunca son iguales.- Sirven como claves de propiedad que no chocan con otras y quedan fuera de
Object.keys,for…iny JSON. - No son seguridad: se pueden listar con
Object.getOwnPropertySymbols. Symbol.for(clave)comparte un mismo símbolo en todo el programa.- El lenguaje usa símbolos conocidos, como
Symbol.iterator, para comportamientos comofor…of.
¡A practicar!
Tu progreso se guarda en este navegador.
Autoevaluación: Valores únicos
Resuelto
Elige una respuesta en cada pregunta.
¿Qué da
Symbol("a") === Symbol("a")?¿Y
Symbol.for("a") === Symbol.for("a")?¿Qué imprime
JSON.stringify({ a: 1, [Symbol("b")]: 2 })?¿Para qué sirve un símbolo?
Ordena la salida: Una propiedad con clave símbolo
Resuelto
Ordena los resultados tal como aparecerían en la consola.
1const s = Symbol("color");2const obj = { forma: "círculo", [s]: "rojo" };3 4console.log(typeof s);5console.log(s.description);6console.log(obj[s]);7console.log(JSON.stringify(obj));8console.log(Object.keys(obj).length);Consola, de arriba abajo
- rojo
- 1
- symbol
- {"forma":"círculo"}
- color
typeof de un símbolo es "symbol", y description devuelve su descripción. Con el símbolo lees la propiedad, pero JSON.stringify y Object.keys no la ven: solo cuentan forma.
Detective: Un símbolo con new
Resuelto
Alguien intentó crear un símbolo y obtuvo este error. Encuentra la línea y elige el arreglo.
Consola
usuario.js:2
const id = new Symbol("id");
^
TypeError: Symbol is not a constructorPaso 1: toca la línea de código que causa el error.
Paso 2: ¿cómo lo arreglas?
Laboratorio: Una marca que no pisa nada
Resuelto
Tienes que agregarle una marca interna a un objeto que no es tuyo, pero el código actual pisa su id. Usa un símbolo para que la marca conviva con el id original.
$ node programa.js
Lo que debe cumplir
- Imprime
7, despuésinterno-42y después2(pendiente) usuario.idsigue valiendo7(pendiente)- La marca usa un
Symbolcomo clave (pendiente)
Una solución
1const usuario = { id: 7, nombre: "Ana" };2 3const marca = Symbol("marca");4usuario[marca] = "interno-42";5 6console.log(usuario.id);7console.log(usuario[marca]);8console.log(Object.keys(usuario).length);Con un símbolo como clave, tu marca convive con la propiedad id sin pisarla, y no aparece en Object.keys: el objeto sigue teniendo 2 claves de texto. Es justo lo que hacen las librerías para guardar datos propios en objetos que no son suyos.