in

prop

Ein String oder Symbol, das einen Eigenschaftsnamen darstellt (Nicht-Symbole werden in Zeichenfolgen umgewandelt). Kann auch eine private Eigenschaftskennung sein.

object

Objekt, um zu prüfen, ob es (oder seine Prototypkette) die Eigenschaft mit dem angegebenen Namen (prop) enthält.

TypeError

Wird ausgelöst, wenn object kein Objekt ist (d. h. ein primitiver Wert).

Der in Operator testet, ob eine String- oder Symbol-Eigenschaft in einem Objekt oder dessen Prototypenkette vorhanden ist. Wenn Sie nur nicht vererbte Eigenschaften überprüfen möchten, verwenden Sie stattdessen Object.hasOwn().

Eine Eigenschaft kann in einem Objekt vorhanden sein, aber den Wert undefined haben. Daher ist x in obj nicht dasselbe wie obj.x !== undefined. Um in nach Hinzufügen einer Eigenschaft false zurückgeben zu lassen, verwenden Sie den delete Operator anstelle des Setzens des Wertes dieser Eigenschaft auf undefined.

Sie können auch den in Operator verwenden, um zu überprüfen, ob ein bestimmtes privates Klassenfeld oder Methode in einem Objekt definiert wurde. Der Operator gibt true zurück, wenn die Eigenschaft definiert ist, und false, wenn nicht. Dies wird als branded check bezeichnet, da er true zurückgibt, wenn und nur wenn das Objekt mit diesem Klassenkonstruktor erstellt wurde, danach können Sie sicher auf andere private Eigenschaften zugreifen.

Dies ist eine spezielle Syntax — die linke Seite des in Operators ist ein Eigenschaftsbezeichner anstelle eines Ausdrucks, aber unquoted (weil es sonst eine String-Eigenschaft und keine private Eigenschaft wäre).

Da das Zugreifen auf private Eigenschaften in Objekten, die nicht mit der aktuellen Klasse verwandt sind, einen TypeError auslöst anstelle von undefined zurückzugeben, erlaubt diese Syntax Ihnen, Folgendes zu verkürzen:

class C {
  #x;
  static isC(obj) {
    try {
      obj.#x;
      return true;
    } catch {
      return false;
    }
  }
}

Zu:

class C {
  #x;
  static isC(obj) {
    return #x in obj;
  }
}

Dies vermeidet im Allgemeinen auch den Umgang mit Fehlerbehandlung, nur um auf eine möglicherweise nicht vorhandene private Eigenschaft zuzugreifen.

Der in Operator erfordert jedoch weiterhin, dass die private Eigenschaft vorher in der umgebenden Klasse deklariert wird — andernfalls würde er einen SyntaxError auslösen („Privatfeld '#x' muss in einer umgebenden Klasse deklariert werden“), denselben, den Sie erhalten, wenn Sie versuchen, auf eine nicht deklarierte private Eigenschaft zuzugreifen.

class C {
  foo() {
    #x in this;
  }
}

new C().foo(); // SyntaxError: Private field '#x' must be declared in an enclosing class

Die folgenden Beispiele zeigen einige Verwendungen des in Operators.

// Arrays
const trees = ["redwood", "bay", "cedar", "oak", "maple"];
0 in trees; // returns true
3 in trees; // returns true
6 in trees; // returns false
"bay" in trees; // returns false (you must specify the index number, not the value at that index)
"length" in trees; // returns true (length is an Array property)
Symbol.iterator in trees; // returns true

// Predefined objects
"PI" in Math; // returns true

// Custom objects
const myCar = { make: "Honda", model: "Accord", year: 1998 };
"make" in myCar; // returns true
"model" in myCar; // returns true

Sie müssen ein Objekt auf der rechten Seite des in Operators angeben. Zum Beispiel können Sie eine mit dem String Konstruktor erstellte Zeichenfolge angeben, aber nicht eine String-Konstante.

const color1 = new String("green");
"length" in color1; // returns true

const color2 = "coral";
// generates an error (color2 is not a String object)
"length" in color2;

Wenn Sie eine Eigenschaft mit dem delete Operator löschen, gibt der in Operator false für diese Eigenschaft zurück.

const myCar = { make: "Honda", model: "Accord", year: 1998 };
delete myCar.make;
"make" in myCar; // returns false

const trees = ["redwood", "bay", "cedar", "oak", "maple"];
delete trees[3];
3 in trees; // returns false

Wenn Sie eine Eigenschaft auf undefined setzen, ohne sie zu löschen, gibt der in Operator true für diese Eigenschaft zurück.

const myCar = { make: "Honda", model: "Accord", year: 1998 };
myCar.make = undefined;
"make" in myCar; // returns true

const trees = ["redwood", "bay", "cedar", "oak", "maple"];
trees[3] = undefined;
3 in trees; // returns true

Der in Operator gibt false für leere Array-Slots zurück, selbst wenn der direkte Zugriff darauf undefined zurückgibt.

const empties = new Array(3);
empties[2]; // returns undefined
2 in empties; // returns false

Um dies zu vermeiden, stellen Sie sicher, dass ein neues Array immer mit nicht leeren Werten gefüllt wird oder nicht über das Ende des Arrays hinausgeschrieben wird.

const empties = new Array(3).fill(undefined);
2 in empties; // returns true

Der in Operator gibt true für Eigenschaften in der Prototypkette zurück. Dies kann unerwünscht sein, wenn Sie Objekte verwenden, um beliebige Schlüssel-Wert-Paare zu speichern.

const ages = { alice: 18, bob: 27 };

function hasPerson(name) {
  return name in ages;
}

hasPerson("hasOwnProperty"); // true

Sie können Object.hasOwn() verwenden, um zu überprüfen, ob das Objekt den Schlüssel hat.

const ages = { alice: 18, bob: 27 };

function hasPerson(name) {
  return Object.hasOwn(ages, name);
}

hasPerson("hasOwnProperty"); // false

Alternativ sollten Sie in Betracht ziehen, ein Null-Prototyp-Objekt oder eine Map zum Speichern von ages zu verwenden, um andere Fehler zu vermeiden.

const ages = new Map([
  ["alice", 18],
  ["bob", 27],
]);

function hasPerson(name) {
  return ages.has(name);
}

hasPerson("hasOwnProperty"); // false

Das folgende Codefragment demonstriert eine statische Funktion, die angibt, ob ein Objekt mit dem Person Konstruktor erstellt wurde und daher andere Methoden sicher ausführen kann.

class Person {
  #age;
  constructor(age) {
    this.#age = age;
  }
  static isPerson(o) {
    return #age in o;
  }
  ageDifference(other) {
    return this.#age - other.#age;
  }
}

const p1 = new Person(20);
const p2 = new Person(30);
console.log(p1.ageDifference(p2)); // -10
console.log(Person.isPerson(p1)); // true

if (Person.isPerson(p1) && Person.isPerson(p2)) {
  console.log(p1.ageDifference(p2)); // -10
}

Es hilft, den folgenden Fall zu vermeiden:

const p2 = {};

p1.ageDifference(p2); // TypeError: Cannot read private member #age from an object whose class did not declare it

Ohne den in Operator müssten Sie einen try...catch Block verwenden, um zu prüfen, ob das Objekt die private Eigenschaft hat.

Sie können dies auch als Methode [Symbol.hasInstance]() der Klasse implementieren, sodass Sie den instanceof Operator verwenden können, um dieselbe Prüfung durchzuführen (die standardmäßig nur die Existenz von Person.prototype in der Prototypkette des Objekts überprüft).

class Person {
  #age;
  constructor(age) {
    this.#age = age;
  }
  static [Symbol.hasInstance](o) {
    // Testing `this` to prevent false-positives when
    // calling `instanceof SubclassOfPerson`
    return this === Person && #age in o;
  }
  ageDifference(other) {
    return this.#age - other.#age;
  }
}

const p1 = new Person(20);
const p2 = new Person(30);

if (p1 instanceof Person && p2 instanceof Person) {
  console.log(p1.ageDifference(p2)); // -10
}

Für weitere Beispiele siehe Private Eigenschaften und den Klassen-Leitfaden.

• for...in
• delete
• Object.hasOwn()
• Reflect.has()
• Aufzählbarkeit und Eigentum von Eigenschaften