JavaScript Symbol — унікальний ключ властивості

Symbol (у перекладі — символ) — примітив, кожне значення якого унікальне. Два символи з однаковим описом не рівні між собою.

правити

Загальний опис

Символ вигадали, щоб розв'язати проблему зіткнення імен. Уяви, що дві бібліотеки додають об'єкту властивість id — друга мовчки перетре першу.

Ключ-символ такого не допускає: він унікальний фізично, а не за іменем. Опис усередині Symbol('id') — лише підказка для налагодження, на рівність вона не впливає.

Властивості з ключем-символом не потрапляють ані в for...in, ані в Object.keys(), ані в JSON.stringify() — тобто вони наче приховані від звичайного коду.

Окремо є системні символи, якими мова описує саму себе: Symbol.iterator робить об'єкт перебірним у for...of, Symbol.toPrimitive керує перетворенням у число чи рядок.

правити

Порада

Symbol.iterator — спосіб зробити свій клас перебірним у for...of. Це не хак, а офіційний протокол мови.

автор: NagarD правити

+ додати пораду чи нотатку

Синтаксис

const sym = Symbol("опис");

властивості

методи

Переглядачі

Стаціонарні переглядачі Мобільні переглядачі Серверні переглядачі

Підтримка: стаціонарні переглядачі

Переглядач
	38	36	9	25	12	—

Підтримка: мобільні переглядачі

Переглядач
	38	38	36	9

Підтримка: серверні переглядачі

Переглядач
	0.12.0	1.0

Приклади

+ запропонувати свій приклад у пісочниці

const id = Symbol('id');
const other = Symbol('id');

console.log(id === other); // false — опис не робить їх рівними

const user = { name: 'Іван', [id]: 42 };

console.log(Object.keys(user)); // ['name'] — символ прихований
console.log(user[id]);          // 42

// свій клас, перебірний у for...of
class Range {
    constructor(from, to) {
        this.from = from;
        this.to = to;
    }

    *[Symbol.iterator]() {
        for (let i = this.from; i <= this.to; i++) {
            yield i;
        }
    }
}

console.log([...new Range(1, 4)]); // [1, 2, 3, 4]