JavaScript Symbol description Property

JavaScript symbol description is an inbuilt property in JavaScript that is used to return the optional description of the specified symbol objects.

Syntax: Here “A” is the specified symbol object which might be Symbol(‘anyValues’), Symbol.iterator, Symbol.for(‘anyValues’) etc.

A.description;

Parameters: This property does not accept any parameter.

Return value: This property returns the optional description of the specified symbol objects.

Example 1: The below examples illustrate the JavaScript Symbol description Property.

javascript




// Calling description property over
// some specified symbol objects
console.log(Symbol('Geek').description);
console.log(Symbol.iterator.description);
console.log(Symbol.for('w3wiki').description);
console.log(Symbol('Beginner').description + 'forBeginner');


Output

Geek
Symbol.iterator
w3wiki
w3wiki


Example 2: The below examples illustrate the JavaScript Symbol description Property.

javascript




// Calling description property over
// a specified symbol objects
console.log(Symbol().description);


Output

undefined


In the above code, the symbol object “Symbol()” should have some parameters otherwise it gives undefined as the output.

Supported Browsers:

  • Chrome 70 and above
  • Edge 79 and above
  • Firefox 63 and above
  • Opera 57 and above
  • Safari 12.1 and above

We have a complete list of Javascript symbols’ properties and methods, to check those please go through the Javascript Symbol Complete Reference article.