1. MDN Web Docs
  2. Schreibrichtlinien
  3. Seitenstrukturen
  4. Seitentypen
  5. API-Konstruktor-Unterseite Vorlage

Dieser Inhalt wurde automatisch aus dem Englischen übersetzt, und kann Fehler enthalten. Erfahre mehr über dieses Experiment.

View in English Always switch to English

API-Konstruktor-Unterseite Vorlage

Hinweis: Entfernen Sie diese ganze erläuternde Anmerkung, bevor Sie veröffentlichen.

Meta-Daten der Seite:

Die Meta-Daten am Anfang der Seite werden verwendet, um "Seitenmetadaten" 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:
  - deprecated
  - experimental
  - non-standard
browser-compat: path.to.feature.NameOfTheConstructor
---
title

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

slug

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

page-type

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

status

Flags, die den Status dieser Funktion 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 Werten in den Browser-Kompatibilitätsdaten für die Funktion gesetzt. Siehe "Wie Feature-Status 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-Daten-Repo. Die Toolchain verwendet den Schlüssel automatisch, um die Kompatibilitäts- und Spezifikationsabschnitte zu füllen (Ersatz der {{Compat}} und {{Specifications}} Makros).

Beachten Sie, dass Sie möglicherweise zuerst einen Eintrag für den API-Konstruktor in unserem Browser-Compat-Daten-Repo erstellen/aktualisieren müssen, und der Eintrag für die API muss Spezifikationsinformationen enthalten. Siehe unseren Leitfaden hierzu.

Makros am Seitenanfang

Eine Reihe von Makroaufrufen erscheint oben im Inhaltsabschnitt (unmittelbar unter den Seitenmetadaten).

Diese Makros werden automatisch von der Toolchain hinzugefügt (es besteht keine Notwendigkeit, hinzuzufügen/zu entfernen):

  • {{SeeCompatTable}} — Dies generiert ein Dies ist eine experimentelle Technologie Banner, das anzeigt, dass die Technologie experimentell ist. Wenn es experimentell ist und die Technologie in Firefox hinter einem Pref versteckt ist, sollten Sie auch einen Eintrag hierfür auf der Seite Experimentelle Funktionen in Firefox ausfüllen.
  • {{Deprecated_Header}} — Dies generiert ein Veraltet Banner, das anzeigt, dass die Nutzung der Technologie abzuraten ist.
  • {{Non-standard_Header}} — Dies generiert ein Nicht-standardmäßig Banner, das anzeigt, dass die Funktion nicht Teil einer Spezifikation ist.

Sie sollten die folgenden Makros gemäß den untenstehenden Ratschlägen aktualisieren oder löschen:

  • {{SecureContext_Header}} — Dies generiert 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 ja, sollten Sie auch einen Eintrag hierfür auf der Seite Auf sichere Kontexte beschränkte Funktionen ausfüllen.
  • {{AvailableInWorkers}} — Dies generiert eine Verfügbar in Workern Notiz, die anzeigt, dass die Technologie im Worker Kontext verfügbar ist. Wenn sie nur im Fensterebenen-Kontext 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 aufgrund ihrer Verfügbarkeit übergeben (siehe {{AvailableInWorkers}} Makro Quellcode für alle verfügbaren Werte), und Sie müssen möglicherweise auch einen Eintrag hierfür auf der Seite Web APIs verfügbar in Workern ausfüllen.
  • {{APIRef("GroupDataName")}} — Dies generiert die linke Referenzseitenleiste, die schnelle Referenzlinks enthält, die mit der aktuellen Seite zusammenhängen. Beispielsweise hat jede Seite in der WebVR API dieselbe Seitenleiste, die auf die anderen Seiten der API verweist. Um die korrekte Seitenleiste für Ihre API zu erzeugen, müssen Sie einen GroupData Eintrag in unser GitHub-Repo hinzufügen und den Namen des Eintrags im Makroaufruf anstelle von GroupDataName einfügen. Weitere Informationen hierzu finden Sie in unserem API-Referenzseitenleisten Leitfaden.

Geben Sie die Status-Header-Makros nicht manuell an. Beziehen Sie sich auf den Abschnitt Wie Feature-Status hinzugefügt oder aktualisiert werden, um diese Status zu der Seite hinzuzufügen.

Beispiele für die Sicherer Kontext, Verfügbar in Workern, Experimentell, Veraltet und Nicht-standardmäßig Banner werden direkt nach diesem Anmerkungsblock angezeigt.

Denken Sie daran, diese ganze erläuternde Anmerkung zu entfernen, bevor Sie veröffentlichen.

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 mit dem Namen des Konstruktors und sagen Sie, was er tut. Dies sollte idealerweise ein oder zwei kurze Sätze sein. Sie können den größten Teil davon der Zusammenfassung des Konstruktors auf der entsprechenden API-Referenzseite entnehmen.

Syntax

Füllen Sie einen Syntaxkasten aus, entsprechend den Anweisungen in unserem Artikel Syntaxabschnitte.

Parameter

parameter1 Optional

Fügen Sie hier eine kurze Beschreibung des Parameters und seiner Funktion ein. 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

usw.

Rückgabewert

Fügen Sie eine Beschreibung des Rückgabewerts des Konstruktors ein, einschließlich des Datentyps und was er repräsentiert. Dies ist normalerweise einfach "Eine Instanz des {{domxref("NameOfTheParentInterface")}} Objekts."

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

Ausnahmen

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

Exception1

Fügen Sie Beschreibungen hinzu, wie die Ausnahme ausgelöst wird.

Exception2

Fügen Sie Beschreibungen hinzu, 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, den name der Ausnahme.

Hier ist ein Beispiel, wo eine Methode eine DOMException mit einem Namen IndexSizeError, eine zweite DOMException mit einem 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 nennt. 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.

Sehen Sie unseren Leitfaden an, wie Sie Codebeispiele hinzufügen für weitere Informationen.

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

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 "Mehr Beispiele", unter dem Sie auf die Beispiele auf anderen Seiten verlinken können. Zum Beispiel:

md
## Beispiele

### Verwendung der Fetch-API

Beispiel von Fetch

### Mehr Beispiele

Links zu mehr 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 die Links direkt unter der H2-Überschrift "Beispiele" hinzu. Zum Beispiel:

md
## Beispiele

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

Spezifikationen

{{Specifications}}

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

Browser-Kompatibilität

{{Compat}}

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

Siehe auch

Fügen Sie Links zu Referenzseiten und Leitfäden hinzu, die mit der aktuellen API verwandt sind. Für weitere Richtlinien siehe den Siehe auch Abschnitt im Schreibstil-Leitfaden.

  • link1
  • link2
  • external_link (Jahr)

Help improve MDN

Learn how to contribute Diese Seite wurde automatisch aus dem Englischen übersetzt.
Übersetzung auf GitHub anzeigen • Fehler mit dieser Übersetzung melden