What are javascript symbols and how can they help you?

by Janeth Kent Date: 20-12-2022 javascript

Symbols are a new primitive value introduced by ES6. Their purpose is to provide us unique identifiers. In this article, we tell you how they work, in which way they are used with JavaScript and how they can help us.

How to create symbols

To create a new symbol we will have to use its constructor:

 
const symbol = Symbol();
 

The function has an optional string parameter that acts as a description.

 
const symbol = Symbol('description');
console.log(symbol);//Symbol(description)
 

The important thing is that, even if you use the same description more than once, each symbol is unique.

 
Symbol('description') === Symbol('description');
//false
As I said before, symbols are new primitive values and have their own type. We can check this by using typeof:
 
typeof Symbol();
//symbol

Converting to symbol type

You already know that in Javascript it is possible to convert types. A big part of this is the implicit conversion, that happens when we use values of different types together:

 
console.log(1 + " added to " + 2 + " equals " + 3); 
//1 added to 2 equals 3
 

Although there are types that are compatible, this is not the case for symbols.

 
const symbol = Symbol('Hello');
symbol + 'world!';
//Uncaught TypeError: Cannot convert a Symbol value to a string
 

If you want to use symbols in this way, you will have to convert it or use the "description" property.

 
const symbol = Symbol('Hello');
console.log(`${symbol.description} world!`);
//Hello world!
 

How to use symbols

Before we dive into symbols, it goes without saying that the keys of an object could only be strings. Trying to use an object as a key for a property does not return an expected result.

 
const key = {};
const myObject = {
  [key]: 'Hello world!'
};
console.log(myObject);
/*
{
 [object Object]: 'Hello world!'
 }
 */
 

This is not the case for symbols. The ECMAScript specification states that we can use them as keys. So let's give it a try.

 
const key = Symbol();
const myObject = {
 [key]: 'Hello world!'
 };
 console.log(myObject);
 /*
 {
  Symbol(): 'Hello world!'
  }
 */
 

Even if two symbols have the same description, they will not overlap when used as keys:

 
const key = Symbol('key');
const myObject = {
 [key]: 'Hello world!'

};

console.log(myObject[key] === myObject[Symbol('key')]);

//false
 

This means that we can assign an unlimited number of unique symbols and not worry about conflicts between them.

Accessing the value

Now, the only way to access our value is to use the symbol.

 
console.log(myObject[key]); // Hello world!



There are some differences when it comes to iterating through the properties of an object with symbols. The Object.keys, Object.entries and Object.entries functions do not give us access to any values that use symbols, the same is true for a for ... in. The easiest way to iterate through them is to use the Object.getOwnPropertySymbols function.

 
const key = Symbol();
const myObject = {
 [key]: 'Hello world!'
};

Object.getOwnPropertySymbols(myObject)
  .forEach((symbol) => {
    console.log(myObject[symbol]);
 });
//Hello world!
 

Judging from the above, we can conclude that the symbols provide us with a hidden layer underneath the object, separate from the keys which are strings.

Symbols are unique... at least, most of the time.

The way to create a global symbol is to use the Symbol.for function.

 
const symbol = Symbol.for('key');
console.log(symbol === Symbol.for('key'));
//true
 

If you have doubts about whether a symbol is unique, you can use the Symbol.keyFor function. It returns the associated key if found.

 
Symbol.keyFor(
  
Symbol.for('key')
);
//key
 
Symbol.keyFor(
 Symbol('key')
);
//undefined
 

 
by Janeth Kent Date: 20-12-2022 javascript hits : 10179  
 
Janeth Kent

Janeth Kent

Licenciada en Bellas Artes y programadora por pasión. Cuando tengo un rato retoco fotos, edito vídeos y diseño cosas. El resto del tiempo escribo en MA-NO WEB DESIGN AND DEVELOPMENT.

 
 
 

Related Posts

How to upload files to the server using JavaScript

In this tutorial we are going to see how you can upload files to a server using Node.js using JavaScript, which is very common. For example, you might want to…

How to combine multiple objects in JavaScript

In JavaScript you can merge multiple objects in a variety of ways. The most commonly used methods are the spread operator ... and the Object.assign() function.   How to copy objects with…

The Payment Request API: Revolutionizing Online Payments (Part 2)

In the first part of this series, we explored the fundamentals of the Payment Request API and how it simplifies the payment experience. Now, let's delve deeper into advanced features…

The Payment Request API: Revolutionizing Online Payments (Part 1)

The Payment Request API has emerged as the new standard for online payments, transforming the way transactions are conducted on the internet. In this two-part series, we will delve into…

Let's create a Color Picker from scratch with HTML5 Canvas, Javascript and CSS3

HTML5 Canvas is a technology that allows developers to generate real-time graphics and animations using JavaScript. It provides a blank canvas on which graphical elements, such as lines, shapes, images…

How do you stop JavaScript execution for a while: sleep()

A sleep()function is a function that allows you to stop the execution of code for a certain amount of time. Using a function similar to this can be interesting for…

Mastering array sorting in JavaScript: a guide to the sort() function

In this article, I will explain the usage and potential of the sort() function in JavaScript.   What does the sort() function do?   The sort() function allows you to sort the elements of…

Infinite scrolling with native JavaScript using the Fetch API

I have long wanted to talk about how infinite scroll functionality can be implemented in a list of items that might be on any Web page. Infinite scroll is a technique…

Sorting elements with SortableJS and storing them in localStorage

SortableJS is a JavaScript extension that you will be able to use in your developments to offer your users the possibility to drag and drop elements in order to change…

What is a JWT token and how does it work?

JWT tokens are a standard used to create application access tokens, enabling user authentication in web applications. Specifically, it follows the RFC 7519 standard. What is a JWT token A JWT token…

Template Literals in JavaScript

Template literals, also known as template literals, appeared in JavaScript in its ES6 version, providing a new method of declaring strings using inverted quotes, offering several new and improved possibilities. About…

How to use the endsWith method in JavaScript

In this short tutorial, we are going to see what the endsWith method, introduced in JavaScript ES6, is and how it is used with strings in JavaScript. The endsWith method is…

Clicky