API-Konstruktor-Unterseite-Vorlage

Hinweis: Entfernen Sie diese gesamte erläuternde Notiz vor der Veröffentlichung

Seiteneigenschaften:

Die Metadaten am Anfang der Seite werden verwendet, um "Seiten-Metadaten" zu definieren. Die Werte sollten entsprechend für den Konstruktor aktualisiert werden.

md
---
title: NameOfTheParentInterface: NameOfTheConstructor() Konstruktor
slug: Web/API/NameOfTheParentInterface/NameOfTheConstructor
page-type: web-api-constructor
status:
  - experimental
  - deprecated
  - non-standard
browser-compat: path.to.feature.NameOfTheConstructor
---
title

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

slug

Der Endteil 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 (es endet mit NameOfTheConstructor nicht NameOfTheConstructor()).

page-type

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

status

Flags, die den Status dieses Features beschreiben. Ein Array, das einen oder mehrere der folgenden 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 "Anleitung zum Hinzufügen oder Aktualisieren von Feature-Status".

browser-compat

Ersetzen Sie den Platzhalterwert path.to.feature.NameOfTheConstructor durch den Abfragestring für den Konstruktor im Browser compat data repo. Die Werkzeugkette verwendet automatisch den Schlüssel, um die Kompatibilitäts- und Spezifikationsabschnitte zu füllen (ersetzt die {{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 Seiteneingang

Eine Reihe von Makroaufrufen erscheint am Anfang des Inhaltsabschnitts (unmittelbar unter den Seiteneigenschaften).

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

  • {{SeeCompatTable}} — Dies erzeugt ein Diese Technologie ist experimentell Banner, das anzeigt, dass die Technologie experimentell ist. Wenn es experimentell ist und die Technologie hinter einem Präferenzschalter in Firefox versteckt 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 Nutzung der Technologie nicht empfohlen ist.
  • {{Non-standard_Header}} — Dies erzeugt ein Nicht-standardisiertes Banner, das anzeigt, dass das Feature nicht Teil einer Spezifikation ist.

Sie sollten die folgenden Makros gemäß den unten stehenden Ratschlägen 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. Ist dies nicht der Fall, können Sie den Makroaufruf entfernen. Wenn doch, sollten Sie auch einen Eintrag auf der Seite Einschränkungen für sichere Kontexte ausfüllen.
  • {{AvailableInWorkers}} — Dies erzeugt einen Verfügbar in Workern Hinweis, dass die Technologie im Worker-Kontext verfügbar ist. Wenn es nur im Fensterkontext verfügbar ist, können Sie den Makroaufruf entfernen. Wenn es auch oder nur im Worker-Kontext verfügbar ist, müssen Sie möglicherweise einen Parameter hinzufügen, da es verfügbar ist (siehe {{AvailableInWorkers}} Makro Source Code für alle verfügbaren Werte), möglicherweise müssen Sie auch einen Eintrag auf der Seite Web APIs verfügbar in Workern ausfüllen.
  • {{APIRef("GroupDataName")}} — Dies erzeugt die linke Referenzseitenleiste, die schnelle Referenzlinks zur aktuellen Seite zeigt. Zum Beispiel hat jede Seite 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 verwenden. Lesen Sie unseren API-Referenzseitenleisten Leitfaden, um weitere Informationen darüber zu erhalten.
  • Denken Sie daran, das {{MDNSidebar}} Makro zu entfernen, wenn Sie diese Seite kopieren.

Stellen Sie keine Statusheader-Makros manuell bereit. Beziehen Sie sich auf den Abschnitt Anleitung zum Hinzufügen oder Aktualisieren von Feature-Status, um diese Stati auf der Seite hinzuzufügen.

Beispiele für die Sicherer Kontext, Verfügbar in Workern, Experimentell, Veraltet und Nicht-standardisiert Banner werden unmittelbar nach diesem Hinweisblock angezeigt.

Denken Sie daran, diese gesamte erläuternde Notiz 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: Dieses Feature ist verfügbar in Web Workers.

Experimentell: Dies ist eine experimentelle Technologie
Überprüfen Sie die Browser-Kompatibilitätstabelle sorgfältig, bevor Sie diese produktiv verwenden.

Veraltet: Diese Funktion wird nicht mehr empfohlen. Obwohl einige Browser sie möglicherweise noch unterstützen, kann sie bereits aus den relevanten Webstandards entfernt worden sein, befindet sich im Prozess der Entfernung oder wird nur aus Kompatibilitätsgründen beibehalten. Vermeiden Sie die Verwendung und aktualisieren Sie gegebenenfalls bestehenden Code; siehe die Kompatibilitätstabelle am Ende dieser Seite, um Ihre Entscheidung zu treffen. Beachten Sie, dass diese Funktion jederzeit nicht mehr funktionieren kann.

Kein Standard: Diese Funktion ist nicht standardisiert und befindet sich nicht im Standardisierungsprozess. Verwenden Sie sie nicht auf Produktionsseiten, die auf das Web ausgerichtet sind: Sie wird nicht für alle Benutzer funktionieren. Außerdem kann es große Inkompatibilitäten zwischen Implementierungen geben und das Verhalten kann sich in Zukunft ändern.

Beginnen Sie den Inhalt auf der Seite mit einem einleitenden Absatz – beginnen Sie mit der Benennung des Konstruktors und erläutern Sie, was er tut. Dies sollte idealerweise ein oder zwei kurze Sätze umfassen. Sie könnten einen Großteil davon von der Zusammenfassung des Konstruktors auf der entsprechenden API-Referenzseite übernehmen.

Syntax

Füllen Sie ein Syntaxfeld gemäß der Anleitung in unserem Artikel zu Syntaxabschnitten aus.

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 das {{optional_inline}} Makro.

parameter2

etc.

Rückgabewert

Fügen Sie eine Beschreibung des Rückgabewerts des Konstruktors hinzu, einschließlich des Datentyps und was er darstellt. Dies ist normalerweise einfach "Ein Beispiel des {{domxref("NameOfTheParentInterface")}} Objekts."

Zum Verwenden dieses Makros, entfernen Sie die Backticks und das Backslash im Markdown-Dokument.

Ausnahmen

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

Exception1

Beschreiben Sie, wie die Ausnahme ausgelöst wird.

Exception2

Beschreiben Sie, 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

Geworfen …

InvalidNodeTypeError DOMException

Geworfen …

TypeError

Geworfen …

Beispiele

Eine beschreibende Überschrift

Jedes Beispiel muss eine H3-Überschrift haben, die das Beispiel benennt. Die Überschrift sollte beschreibend sein, 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 Sie Codebeispiele hinzufügen, um weitere Informationen zu erhalten.

Hinweis: Manchmal möchten Sie auf Beispiele verlinken, die auf einer anderen Seite gegeben sind.

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

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

md
## 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 und keine auf dieser Seite haben:

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

md
## Beispiele

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

Spezifikationen

{{Specifications}}

Zum Verwenden dieses Makros, entfernen Sie die Backticks und das Backslash im Markdown-Dokument.

Browser-Kompatibilität

{{Compat}}

Zum Verwenden dieses Makros, entfernen Sie die Backticks und das Backslash im Markdown-Dokument.

Siehe auch

Fügen Sie Links zu Referenzseiten und Leitfäden hinzu, die mit der aktuellen API in Verbindung stehen. Weitere Richtlinien finden Sie im Abschnitt Siehe auch im Writing style guide.

  • link1
  • link2
  • external_link (Jahr)