Cómo utilizar colecciones de JavaScript: mapa y configuración

Introducción

En JavaScript, objectsse utilizan para almacenar varios valores como una estructura de datos compleja.

Un objeto se crea con llaves {…}y una lista de propiedades. Una propiedad es un par clave-valor donde keydebe ser una cadena y valuepuede ser de cualquier tipo.

Por otro lado, arraysson una colección ordenada que puede contener datos de cualquier tipo. En JavaScript, las matrices se crean con corchetes [...]y permiten elementos duplicados.

Hasta ES6 (ECMAScript 2015), JavaScript objectsy arrayseran las estructuras de datos más importantes para manejar colecciones de datos. La comunidad de desarrolladores no tenía muchas opciones fuera de eso. Aun así, una combinación de objetos y matrices pudo manejar datos en muchos escenarios.

Sin embargo, hubo algunas deficiencias,

  • Las claves de objeto solo pueden ser de tipo string.
  • Los objetos no mantienen el orden de los elementos insertados en ellos.
  • Los objetos carecen de algunos métodos útiles, lo que dificulta su uso en algunas situaciones. Por ejemplo, no puede calcular el tamaño ( length) de un objeto fácilmente. Además, enumerar un objeto no es tan sencillo.
  • Las matrices son colecciones de elementos que permiten duplicados. Admitir matrices que solo tienen elementos distintos requiere lógica y código adicionales.

Con la introducción de ES6, obtuvimos dos nuevas estructuras de datos que abordan las deficiencias mencionadas anteriormente, Mapy Set. En este artículo, veremos ambos de cerca y entenderemos cómo usarlos en diferentes situaciones.

Mapa

Mapes una colección de pares clave-valor donde la clave puede ser de cualquier tipo. Maprecuerda el orden de inserción original de sus elementos, lo que significa que los datos se pueden recuperar en el mismo orden en que se insertaron.

En otras palabras, Maptiene características de ambos Objecty Array:

  • Como un objeto, es compatible con la estructura de pares clave-valor.
  • Como una matriz, recuerda el orden de inserción.

Cómo crear e inicializar un mapa

Se Mappuede crear un nuevo como este:

const map = new Map();

Que devuelve un vacío Map:

Map(0) {}

Otra forma de crear un Mapes con valores iniciales. Aquí se explica cómo crear un Mapcon tres pares clave-valor:

const freeCodeCampBlog = new Map([ ['name', 'freeCodeCamp'], ['type', 'blog'], ['writer', 'Tapas Adhikary'], ]);

Que devuelve un Mapcon tres elementos:

Map(3) {"name" => "freeCodeCamp", "type" => "blog", "writer" => "Tapas Adhikary"}

Cómo agregar valores a un mapa

Para agregar valor a un mapa, use el set(key, value)método.

El set(key, value)método tiene dos parámetros, keyy value, donde la clave y el valor pueden ser de cualquier tipo, una primitiva ( boolean, string, number, etc.) o un objeto:

// create a map const map = new Map(); // Add values to the map map.set('name', 'freeCodeCamp'); map.set('type', 'blog'); map.set('writer', 'Tapas Adhikary');

Salida:

Map(3) {"name" => "freeCodeCamp", "type" => "blog", "writer" => "Tapas Adhikary"}

Tenga en cuenta que si usa la misma clave para agregar un valor a Mapvarias veces, siempre reemplazará el valor anterior:

// Add a different writer map.set('writer', 'Someone else!');

Entonces la salida sería:

Map(3)  {"name" => "freeCodeCamp", "type" => "blog", "writer" => "Someone else!"}

Cómo obtener valores de un mapa

Para obtener un valor de a Map, use el get(key)método:

map.get('name'); // returns freeCodeCamp

Todo sobre las claves de mapa

Maplas claves pueden ser de cualquier tipo, una primitiva o un objeto. Esta es una de las principales diferencias entre Maplos objetos JavaScript regulares y donde la clave solo puede ser una cadena:

// create a Map const funMap = new Map(); funMap.set(360, 'My House Number'); // number as key funMap.set(true, 'I write blogs!'); // boolean as key let obj = {'name': 'tapas'} funMap.set(obj, true); // object as key console.log(funMap);

Aquí está el resultado:

Map(3) { 360 => "My House Number", true => "I write blogs!", {…} => true }

Un objeto JavaScript normal siempre trata la clave como una cadena. Incluso cuando le pasa una primitiva u objeto, internamente convierte la clave en una cadena:

// Create an empty object const funObj = {}; // add a property. Note, passing the key as a number. funObj[360] = 'My House Number'; // It returns true because the number 360 got converted into the string '360' internally! console.log(funObj[360] === funObj['360']);

Propiedades y métodos del mapa

JavaScript Maptiene propiedades y métodos incorporados que lo hacen fácil de usar. Éstos son algunos de los más comunes:

  • Utilice la sizepropiedad para saber cuántos elementos hay en un Map:
console.log('size of the map is', map.size);
  • Busca un elemento con el has(key)método:
// returns true, if map has an element with the key, 'John' console.log(map.has('John')); // returns false, if map doesn't have an element with the key, 'Tapas' console.log(map.has('Tapas')); 
  • Elimina un elemento con el delete(key)método:
map.delete('Sam'); // removes the element with key, 'Sam'.
  • Utilice el clear()método para eliminar todos los elementos de Mapuna vez:
// Clear the map by removing all the elements map.clear(); map.size // It will return, 0 

MapIterator: claves (), valores () y entradas ()

Los métodos keys(), values()y entries()métodos devuelven una MapIterator, que es excelente porque se puede utilizar una for-ofo forEachbucle directamente sobre ella.

Primero, cree un simple Map:

const ageMap = new Map([ ['Jack', 20], ['Alan', 34], ['Bill', 10], ['Sam', 9] ]);
  • Obtén todas las llaves:
console.log(ageMap.keys()); // Output: // MapIterator {"Jack", "Alan", "Bill", "Sam"}
  • Obtenga todos los valores:
console.log(ageMap.values()); // Output // MapIterator {20, 34, 10, 9}
  • Obtenga todas las entradas (pares clave-valor):
console.log(ageMap.entries()); // Output // MapIterator {"Jack" => 20, "Alan" => 34, "Bill" => 10, "Sam" => 9}

Cómo iterar sobre un mapa

Puede usar el bucle forEacho for-ofpara iterar sobre un Map:

// with forEach ageMap.forEach((value, key) => { console.log(`${key} is ${value} years old!`); }); // with for-of for(const [key, value] of ageMap) { console.log(`${key} is ${value} years old!`); }

La salida será la misma en ambos casos:

Jack is 20 years old! Alan is 34 years old! Bill is 10 years old! Sam is 9 years old!

Cómo convertir un objeto en un mapa

Puede encontrar una situación en la que necesite convertir una estructura similar objecta una Map. Puedes usar el método entriesde Objectpara hacer eso:

const address = { 'Tapas': 'Bangalore', 'James': 'Huston', 'Selva': 'Srilanka' }; const addressMap = new Map(Object.entries(address));

Cómo convertir un mapa en un objeto

Si desea hacer lo contrario, puede usar el fromEntriesmétodo:

Object.fromEntries(map)

How to Convert a Map into an Array

There are a couple of ways to convert a map into an array:

  • Using Array.from(map):
const map = new Map(); map.set('milk', 200); map.set("tea", 300); map.set('coffee', 500); console.log(Array.from(map));
  • Using the spread operator:
console.log([...map]);

Map vs. Object: When should you use them?

Map has characteristics of both object and array. However, Map is more like an object than array due to the nature of storing data in the key-value format.

The similarity with objects ends here though. As you've seen, Map is different in a lot of ways. So, which one should you use, and when? How do you decide?

Use Map when:

  • Your needs are not that simple. You may want to create keys that are non-strings. Storing an object as a key is a very powerful approach. Map gives you this ability by default.
  • You need a data structure where elements can be ordered. Regular objects do not maintain the order of their entries.
  • You are looking for flexibility without relying on an external library like lodash. You may end up using a library like lodash because we do not find methods like has(), values(), delete(), or a property like size with a regular object. Map makes this easy for you by providing all these methods by default.

Use an object when:

  • You do not have any of the needs listed above.
  • You rely on JSON.parse() as a Map cannot be parsed with it.

Set

A Set is a collection of unique elements that can be of any type. Set is also an ordered collection of elements, which means that elements will be retrieved in the same order that they were inserted in.

A Set in JavaScript behaves the same way as a mathematical set.

How to Create and Initialize a Set

A new Set can be created like this:

const set = new Set(); console.log(set);

And the output will be an empty Set:

Set(0) {}

Here's how to create a Set with some initial values:

const fruteSet = new Set(['?', '?', '?', '?']); console.log(fruteSet);

Output:

Set(4) {"?", "?", "?", "?"}

Set Properties and Methods

Set has methods to add an element to it, delete elements from it, check if an element exists in it, and to clear it completely:

  • Use the size property to know the size of the Set. It returns the number of elements in it:
set.size
  • Use the add(element) method to add an element to the Set:
// Create a set - saladSet const saladSet = new Set(); // Add some vegetables to it saladSet.add('?'); // tomato saladSet.add('?'); // avocado saladSet.add('?'); // carrot saladSet.add('?'); // cucumber console.log(saladSet); // Output // Set(4) {"?", "?", "?", "?"}

I love cucumbers! How about adding one more?

Oh no, I can't – Set is a collection of unique elements:

saladSet.add('?'); console.log(saladSet);

The output is the same as before – nothing got added to the saladSet.

  • Use the has(element) method to search if we have a carrot (?) or broccoli (?) in the Set:
// The salad has a ?, so returns true console.log('Does the salad have a carrot?', saladSet.has('?')); // The salad doesn't have a ?, so returns false console.log('Does the salad have broccoli?', saladSet.has('?'));
  • Use the delete(element) method to remove the avocado(?) from the Set:
saladSet.delete('?'); console.log('I do not like ?, remove from the salad:', saladSet);

Now our salad Set is as follows:

Set(3) {"?", "?", "?"}
  • Use the clear() method to remove all elements from a Set:
saladSet.clear();

How to Iterate Over a Set

Set has a method called values() which returns a SetIterator to get all its values:

// Create a Set const houseNos = new Set([360, 567, 101]); // Get the SetIterator using the `values()` method console.log(houseNos.values());

Output:

SetIterator {360, 567, 101}

We can use a forEach or for-of loop on this to retrieve the values.

Interestingly, JavaScript tries to make Set compatible with Map. That's why we find two of the same methods as Map, keys() and entries().

As Set doesn't have keys, the keys() method returns a SetIterator to retrieve its values:

console.log(houseNos.keys()); // Output // console.log(houseNos.keys());

With Map, the entries() method returns an iterator to retrieve key-value pairs. Again there are no keys in a Set, so entries() returns a SetIterator to retrieve the value-value pairs:

console.log(houseNos.entries()); // Output // SetIterator {360 => 360, 567 => 567, 101 => 101}

How to Enumerate over a Set

We can enumerate over a Set using forEach and for-of loops:

// with forEach houseNos.forEach((value) => { console.log(value); }); // with for-of for(const value of houseNos) { console.log(value); }

The output of both is:

360 567 101

Sets and Arrays

An array, like a Set, allows you to add and remove elements. But Set is quite different, and is not meant to replace arrays.

The major difference between an array and a Set is that arrays allow duplicate elements. Also, some of the Set operations like delete() are faster than array operations like shift() or splice().

Think of Set as an extension of a regular array, just with more muscles. The Set data structure is not a replacement of the array. Both can solve interesting problems.

How to Convert a Set into an array

Converting a Set into an array is simple:

const arr = [...houseNos]; console.log(arr);

Unique values from an array using the Set

Creating a Set is a really easy way to remove duplicate values from an array:

// Create a mixedFruit array with a few duplicate fruits const mixedFruit = ['?', '?', '?', '?', '?', '?', '?',]; // Pass the array to create a set of unique fruits const mixedFruitSet = new Set(mixedFruit); console.log(mixedFruitSet);

Output:

Set(4) {"?", "?", "?", "?"}

Set and Object

A Set can have elements of any type, even objects:

// Create a person object const person = { 'name': 'Alex', 'age': 32 }; // Create a set and add the object to it const pSet = new Set(); pSet.add(person); console.log(pSet);

Output:

No surprise here – the Set contains one element that is an object.

Let's change a property of the object and add it to the set again:

// Change the name of the person person.name = 'Bob'; // Add the person object to the set again pSet.add(person); console.log(pSet);

What do you think the output will be? Two person objects or just one?

Here is the output:

Set is a collection of unique elements. By changing the property of the object, we haven't changed the object itself. Hence Set will not allow duplicate elements.

Set is a great data structure to use in addition to JavaScript arrays. It doesn't have a huge advantage over regular arrays, though.

Use Set when you need to maintain a distinct set of data to perform set operations on like union, intersection, difference, and so on.

In Summary

Here is a GitHub repository to find all the source code used in this article. If you found it helpful, please show your support by giving it a star: //github.com/atapas/js-collections-map-set

You can read more about both the Map and Set data structures here:

  • Map (MDN)
  • Set (MDN)

You may also like some of my other articles:

  • My Favorite JavaScript Tips and Tricks
  • JavaScript equality and similarity with ==, === and Object.is()

If this article was useful, please share it so others can read it as well. You can @ me on Twitter (@tapasadhikary) with comments, or feel free to follow me.