API-Konstruktor-Vorlagenunterseite

Note: Entfernen Sie diesen gesamten erklärenden Hinweis, bevor Sie ihn veröffentlichen

Seiteneigenschaften:

Die Eigenschaften am Anfang der Seite werden verwendet, um "Seitenmetadaten" zu definieren. Die Werte sollten für den Konstruktor entsprechend aktualisiert werden.
md
---
title: NameOfTheParentInterface: NameOfTheConstructor() constructor
slug: Web/API/NameOfTheParentInterface/NameOfTheConstructor
page-type: web-api-constructor
status:
  - deprecated
  - experimental
  - non-standard
browser-compat: path.to.feature.NameOfTheConstructor
---
title

Titelüberschrift, die oben auf der Seite angezeigt wird. Formatieren Sie sie als NameOfTheParentInterface: NameOfTheConstructor() constructor. Beispielsweise hat der Request() Konstruktor einen title von Request: Request() constructor.

slug

Das Ende des URL-Pfads nach https://developer.mozilla.org/de/docs/. Dies wird wie Web/API/NameOfTheParentInterface/NameOfTheConstructor formatiert. Beachten Sie, dass der Name der Konstruktorfunktion im Slug die Klammern weglässt (er endet in NameOfTheConstructor, nicht NameOfTheConstructor()).

page-type

Der page-type Schlüssel für Web/API-Konstruktoren ist immer web-api-constructor.

status

Kennzeichnungen, die den Status dieses Features beschreiben. Ein Array, das einen oder mehrere der folgenden Punkte enthalten kann: experimental, deprecated, non-standard. Dieser Schlüssel sollte nicht manuell gesetzt werden: Er wird automatisch basierend auf den Werten in den Browser-Kompatibilitätsdaten für das Feature gesetzt. Siehe "Wie Feature-Statuse hinzugefügt oder aktualisiert werden".

browser-compat

Ersetzen Sie den Platzhalterwert path.to.feature.NameOfTheConstructor mit der Abfragezeichenfolge für den Konstruktor im Browser compat data repo. Die Toolchain verwendet den Schlüssel automatisch, um die Kompatibilitäts- und Spezifikationsabschnitte zu füllen (Ersetzen der {{Compat}} und {{Specifications}} Makros).

Beachten Sie, dass Sie möglicherweise zuerst einen Eintrag für den API-Konstruktor in unserem Browser compat data repo erstellen/aktualisieren müssen, und der Eintrag für die API muss Spezifikationsinformationen enthalten. Siehe unser Leitfaden dazu.

Makros am Anfang der Seite

Eine Reihe von Makroaufrufen erscheint oben im Inhaltsbereich (direkt unter den Seiteneigenschaften).

Diese Makros werden automatisch von der Toolchain hinzugefügt (es ist nicht erforderlich, sie hinzuzufügen/zu entfernen):

{{SeeCompatTable}} — Dies erzeugt ein Dies ist eine experimentelle Technologie-Banner, das anzeigt, dass die Technologie experimentell ist. Wenn es experimentell ist und die Technologie hinter einem Pref in Firefox verborgen ist, sollten Sie auch einen Eintrag dafür auf der Seite Experimentelle Funktionen in Firefox ausfüllen.

{{Deprecated_Header}} — Dies erzeugt ein Veraltet-Banner, das anzeigt, dass die Verwendung der Technologie nicht empfohlen wird.

{{Non-standard_Header}} — Dies erzeugt ein Nicht-standard-Banner, das anzeigt, dass das Feature nicht Teil einer Spezifikation ist.

Sie sollten die folgenden Makros gemäß dem nachstehenden Hinweis aktualisieren oder löschen:

{{SecureContext_Header}} — Dies erzeugt ein Sicherer Kontext-Banner, das anzeigt, dass die Technologie nur in einem sicheren Kontext verfügbar ist. Wenn nicht, können Sie den Makroaufruf entfernen. Wenn doch, sollten Sie auch einen Eintrag dafür auf der Seite Funktionen, die auf sichere Kontexte beschränkt sind ausfüllen.

{{AvailableInWorkers}} — Dies erzeugt eine In Workern verfügbar-Notiz, die anzeigt, dass die Technologie im Worker-Kontext verfügbar ist. Wenn sie nur im Fensterkontext verfügbar ist, können Sie den Makroaufruf entfernen. Wenn sie auch oder nur im Worker-Kontext verfügbar ist, müssen Sie möglicherweise einen Parameter hinzufügen, damit sie verfügbar ist (siehe {{AvailableInWorkers}} Makros Quellcode für alle verfügbaren Werte). Sie müssen möglicherweise auch einen Eintrag dafür auf der Seite Web-APIs, die in Workern verfügbar sind ausfüllen.

{{APIRef("GroupDataName")}} — Dies erzeugt die linke Referenz-Seitenleiste mit schnellen Referenzlinks zu der aktuellen Seite. Zum Beispiel hat jede Seite in der WebVR API dieselbe Seitenleiste, die auf die anderen Seiten in der API verweist. Um die korrekte Seitenleiste für Ihre API zu erzeugen, müssen Sie einen GroupData Eintrag zu unserem GitHub-Repo hinzufügen und den Namen des Eintrags im Makroaufruf anstelle von GroupDataName einfügen. Siehe unseren Leitfaden zu API-Referenz-Seitenleisten für Informationen, wie dies zu tun ist.

Status-Header-Makros nicht manuell bereitstellen. Verweisen Sie auf den Abschnitt Wie Feature-Statuse hinzugefügt oder aktualisiert werden, um diese Status zur Seite hinzuzufügen.

Beispiele für die Banner Sicherer Kontext, In Workern verfügbar, Experimentell, Veraltet und Nicht-standard werden direkt nach diesem Hinweisblock gezeigt.

Denken Sie daran, diesen gesamten erklärenden Hinweis vor der Veröffentlichung zu entfernen.

Sicherer Kontext: Diese Funktion ist nur in sicheren Kontexten (HTTPS) in einigen oder allen unterstützenden Browsern verfügbar.

Hinweis: Diese Funktion ist in Web Workers verfügbar.

Experimentell: Dies ist eine experimentelle Technologie
Überprüfen Sie die Browser-Kompatibilitätstabelle sorgfältig vor der Verwendung auf produktiven Webseiten.

Veraltet: Diese Funktion wird nicht mehr empfohlen. Obwohl einige Browser sie möglicherweise noch unterstützen, könnte sie bereits aus den relevanten Webstandards entfernt worden sein, in Kürze entfernt werden oder nur noch aus Kompatibilitätsgründen bestehen. Vermeiden Sie die Verwendung und aktualisieren Sie vorhandenen Code, falls möglich; siehe die Kompatibilitätstabelle am Ende dieser Seite, um Ihre Entscheidung zu unterstützen. Beachten Sie, dass diese Funktion jederzeit aufhören könnte zu funktionieren.

Nicht standardisiert: Diese Funktion ist nicht standardisiert. Wir raten davon ab, nicht-standardisierte Funktionen auf produktiven Webseiten zu verwenden, da sie nur von bestimmten Browsern unterstützt werden und sich in Zukunft ändern oder entfernt werden können. Unter Umständen kann sie jedoch eine geeignete Option sein, wenn es keine standardisierte Alternative gibt.

Beginnen Sie den Inhalt auf der Seite mit einem einleitenden Absatz — beginnen Sie, indem Sie den Konstruktor benennen und erklären, was er macht. Dies sollte idealerweise ein oder zwei kurze Sätze sein. Sie könnten den größten Teil davon von der Zusammenfassung des Konstruktors auf der entsprechenden API-Referenzseite kopieren.

Syntax

Füllen Sie ein Syntaxfeld aus, gemäß der Anleitung in unserem Artikel über Syntaxabschnitte.

Parameter

parameter1 Optional: Fügen Sie hier eine kurze Beschreibung des Parameters und seiner Funktion hinzu. Fügen Sie einen Begriff und eine Definition für jeden Parameter hinzu. Wenn der Parameter nicht optional ist, entfernen Sie den {{optional_inline}} Makroaufruf.
parameter2: etc.

Rückgabewert

Fügen Sie eine Beschreibung des Rückgabewerts des Konstruktors hinzu, einschließlich des Datentyps und was er darstellt. Normalerweise handelt es sich einfach um "Eine Instanz des {{domxref("NameOfTheParentInterface")}} Objekts."

Um dieses Makro zu verwenden, entfernen Sie die Rückwärtsstriche und Backticks in der Markdown-Datei.

Ausnahmen

Fügen Sie eine Liste aller Ausnahmen hinzu, die der Konstruktor auslösen kann. Fügen Sie für jede Ausnahme einen Begriff und eine Definition hinzu.

Exception1: Beschreibungen, wie die Ausnahme ausgelöst wird.
Exception2: Beschreibungen, wie die Ausnahme ausgelöst wird.

Beachten Sie, dass wir zwei Arten von Ausnahmen haben: DOMException Objekte und reguläre JavaScript-Ausnahmen, wie TypeError und RangeError. Ein Webentwickler muss wissen:

welches Objekt geworfen wird
für Ausnahmen, die DOMException Objekte sind, der name der Ausnahme.

Hier ist ein Beispiel, bei dem eine Methode eine DOMException mit dem Namen IndexSizeError, eine zweite DOMException mit dem Namen InvalidNodeTypeError und eine JavaScript-Ausnahme vom Typ TypeError auslösen kann:

IndexSizeError DOMException: Ausgelöst …
InvalidNodeTypeError DOMException: Ausgelöst …
TypeError: Ausgelöst …

Beispiele

Eine beschreibende Überschrift

Jedes Beispiel muss eine H3-Überschrift haben, die das Beispiel benennt. Die Überschrift sollte beschreiben, was das Beispiel tut. Zum Beispiel sagt "Ein einfaches Beispiel" nichts über das Beispiel aus und ist daher keine gute Überschrift. Die Überschrift sollte prägnant sein. Für eine längere Beschreibung verwenden Sie den Absatz nach der Überschrift.

Siehe unseren Leitfaden, wie man Code-Beispiele hinzufügt für mehr Informationen.

Hinweis: Manchmal möchten Sie auf Beispiele auf einer anderen Seite verweisen.

Szenario 1: Wenn Sie einige Beispiele auf dieser Seite und einige weitere Beispiele auf einer anderen Seite haben:

Fügen Sie für jedes Beispiel auf dieser Seite eine H3-Überschrift (###) hinzu und dann eine abschließende H3-Überschrift (###) mit dem Text "Weitere Beispiele", unter der Sie auf die Beispiele auf anderen Seiten verlinken können. Zum Beispiel:

## Beispiele

### Verwendung der Fetch-API

Beispiel von Fetch

### Weitere Beispiele

Links zu weiteren Beispielen auf anderen Seiten

Szenario 2: Wenn Sie nur Beispiele auf einer anderen Seite haben und keine auf dieser Seite:

Fügen Sie keine H3-Überschriften hinzu; fügen Sie die Links direkt unter der H2-Überschrift "Beispiele" hinzu. Zum Beispiel:

## Beispiele

Für Beispiele dieser API, siehe [die Seite über fetch()](https://example.org/).

link1
link2
external_link (year)