Odpowiedź.

Historia pytania:

Typ Symbol został dodany do JavaScript (ES6) w celu tworzenia unikalnych identyfikatorów, które gwarantują, że nie będą kolidować z innymi właściwościami obiektu. TypeScript wspiera symbole od momentu wprowadzenia zgodności z ES6.

Problem:

Przed pojawieniem się Symbol w roli kluczy dla właściwości obiektów często używano ciągów. Prowadziło to do błędów przy rozszerzaniu lub ponownym używaniu obiektów: przypadkowe kolizje nazw i niemożność ukrycia prywatnych właściwości (nawet poprzez konwencje). Symbol pozwolił na tworzenie unikalnych, niewidocznych zewnętrznemu kodowi kluczy, ale pojawiły się pytania dotyczące typizacji — jak opisywać typy z kluczami Symbol i bezpiecznie ich używać w API?

Rozwiązanie:

TypeScript wspiera symbole jako wartości i typy, jednak sama typizacja kluczy Symbol ma swoje cechy. Aby utworzyć symbol, można użyć globalnego konstruktora lub globalnego rejestru symboli. W interfejsach lub typach klucze z symbolami muszą wyraźnie wskazywać typ jako symbol, a dostęp do takich właściwości odbywa się tylko z zapisanym odniesieniem na Symbol.

Przykład kodu:

const SECRET = Symbol('secret');

interface SecretObject {
  [SECRET]: string;
  visible: string;
}

const obj: SecretObject = {
  visible: 'see me',
  [SECRET]: 'hidden',
};

console.log(obj.visible);      // 'see me'
// console.log(obj["secret"]);  // Błąd: nie ma takiej właściwości!
console.log(obj[SECRET]);      // 'hidden'

Kluczowe cechy:

Symbol gwarantuje unikalność klucza właściwości, co jest niemożliwe dla żadnego klucza stringowego.
Właściwości z kluczami Symbol nie są wyświetlane podczas zwykłej iteracji (for...in, Object.keys). Jest to wygodne dla ukrytych właściwości.
Nie wszystkie standardowe operacje (np. JSON.stringify) uwzględniają klucze Symbol — jest to ważne przy serializacji i deserializacji.

Pytania z podstępem.

Czy Symbol może być automatycznie przekształcany na ciąg przy użyciu w obiektach?

Nie, Symbol nie może być automatycznie konwertowany na string, próba zrobienia tego (np. przez konkatenację) spowoduje błąd.

const mySymbol = Symbol('desc');
// alert('prefix_' + mySymbol); // TypeError

Czy można wylistować klucze Symbol za pomocą Object.keys?

Nie, Object.keys i for...in ignorują klucze Symbol. Aby uzyskać takie klucze, używa się Object.getOwnPropertySymbols.

const sym = Symbol('a');
const obj = { [sym]: 42 };
Object.keys(obj); // []
Object.getOwnPropertySymbols(obj); // [Symbol(a)]

Czy właściwości z kluczami Symbol są przenoszone podczas kopiowania przez Object.assign?

Tak, Object.assign kopiuje zarówno klucze stringowe, jak i symboliczne, w przeciwieństwie do JSON.stringify.

const s = Symbol('s');
const o1 = { [s]: 123, foo: 'bar' };
const o2 = Object.assign({}, o1);
o2[s]; // 123

Typowe błędy i antywzorce

Tworzenie symboli bezpośrednio w różnych miejscach (niejawny wielokrotnego użycia Symbol(…)). To prowadzi do różnych, niezgodnych kluczy.
Praca z kluczami Symbol jak z zwykłymi ciągami — to prowadzi do błędów dostępu i utraty właściwości.
Oczekiwanie na serializację kluczy Symbol poprzez JSON.stringify — te właściwości są tracone.

Przykład z życia

Negatywny przypadek

Programista użył do prywatnych właściwości kluczy stringowych ('_private'), polegając na konwencji. W Team B przypadkowo dodano taką samą linię — właściwości się pokryły, pojawił się nieprzewidywalny błąd.

Zalety:

Szybkie prototypowanie.

Wady:

Brak rzeczywistej prywatności.
Możliwość kolizji nazw.
Wycieki danych między częściami systemu.

Pozytywny przypadek

Drugi programista zastosował Symbol dla ukrytych właściwości (np. Symbol('internal')). Teraz nawet w zespole nie można przypadkowo pokryć danych wewnętrznych: dostęp możliwy jest tylko przy posiadaniu odniesienia do konkretnego Symbol.