Array[Symbol.species]

Die statische Zugriffs-eigenschaft Array[Symbol.species] gibt den Konstruktor zurück, der verwendet wird, um Rückgabewerte aus Array-Methoden zu konstruieren.

Warnung: Die Existenz von [Symbol.species] ermöglicht die Ausführung von beliebigem Code und kann Sicherheitslücken schaffen. Außerdem erschwert sie bestimmte Optimierungen erheblich. Entwickler von Engines untersuchen, ob diese Funktion entfernt werden soll. Vermeiden Sie es, sich nach Möglichkeit darauf zu verlassen. Moderne Array-Methoden, wie toReversed(), verwenden [Symbol.species] nicht und geben immer eine neue Instanz der Array-Basisklasse zurück.

Syntax

js
Array[Symbol.species]

Rückgabewert

Der Wert des Konstruktors (this), auf dem get [Symbol.species] aufgerufen wurde. Der Rückgabewert wird verwendet, um Rückgabewerte aus Array-Methoden zu konstruieren, die neue Arrays erstellen.

Beschreibung

Die [Symbol.species] Zugriffs-eigenschaft gibt den Standardkonstruktor für Array-Objekte zurück. Unterklassenkonstruktoren können sie überschreiben, um die Zuweisung des Konstruktors zu ändern. Die Standardimplementierung ist im Wesentlichen:

js
// Hypothetical underlying implementation for illustration
class Array {
  static get [Symbol.species]() {
    return this;
  }
}

Aufgrund dieser polymorphen Implementierung würde [Symbol.species] von abgeleiteten Unterklassen standardmäßig auch den Konstruktor selbst zurückgeben.

js
class SubArray extends Array {}
SubArray[Symbol.species] === SubArray; // true

Wenn Array-Methoden aufgerufen werden, die das bestehende Array nicht ändern, sondern eine neue Array-Instanz zurückgeben (zum Beispiel filter() und map()), wird auf den constructor[Symbol.species] des Arrays zugegriffen. Der zurückgegebene Konstruktor wird verwendet, um den Rückgabewert der Array-Methode zu konstruieren. Es ist damit technisch möglich, dass Array-Methoden Objekte zurückgeben, die nicht mit Arrays verwandt sind.

js
class NotAnArray {
  constructor(length) {
    this.length = length;
  }
}

const arr = [0, 1, 2];
arr.constructor = { [Symbol.species]: NotAnArray };
arr.map((i) => i); // NotAnArray { '0': 0, '1': 1, '2': 2, length: 3 }
arr.filter((i) => i); // NotAnArray { '0': 1, '1': 2, length: 0 }
arr.concat([1, 2]); // NotAnArray { '0': 0, '1': 1, '2': 2, '3': 1, '4': 2, length: 5 }

Beispiele

Species in gewöhnlichen Objekten

Die [Symbol.species]-Eigenschaft gibt die Standard-Konstruktorfunktion zurück, die der Array-Konstruktor für Array ist.

js
Array[Symbol.species]; // [Function: Array]

Species in abgeleiteten Objekten

In einer Instanz einer benutzerdefinierten Array-Unterklasse, wie MyArray, ist die MyArray-Species der MyArray-Konstruktor. Sie möchten dies jedoch möglicherweise überschreiben, um Eltern-Array-Objekte in Ihren Methoden der abgeleiteten Klasse zurückzugeben:

js
class MyArray extends Array {
  // Overwrite MyArray species to the parent Array constructor
  static get [Symbol.species]() {
    return Array;
  }
}

Spezifikationen

Specification
ECMAScript Language Specification
# sec-get-array-%symbol.species%

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch