API-Methode Unterseite Vorlage

Hinweis: Entfernen Sie diese ganze Erklärung, bevor Sie die Seite veröffentlichen.

Seitendaten:

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

---
title: NameOfTheParentInterface.NameOfTheMethod()
slug: Web/API/NameOfTheParentInterface/NameOfTheMethod
page-type: web-api-instance-method OR web-api-static-method
status:
  - deprecated
  - experimental
  - non-standard
browser-compat: path.to.feature.NameOfTheMethod
---

title

Titelüberschrift, die oben auf der Seite angezeigt wird. Formatieren Sie den Titel als "NameOfTheParentInterface: NameOfTheMethod() method". Zum Beispiel hat die count() Methode der IDBIndex Schnittstelle einen title von IDBIndex: count() method.

slug

Der Endteil des URL-Pfads nach https://developer.mozilla.org/de/docs/. Dies wird formatiert als Web/API/NameOfTheParentInterface/NameOfTheMethod.

Wenn die Methode statisch ist, muss der Slug ein _static Suffix haben, wie: Web/API/NameOfTheParentInterface/NameOfTheMethod_static. Dies ermöglicht es uns, Instanz- und statische Methoden mit demselben Namen zu unterstützen.

Beachten Sie, dass der Name der Methode im Slug die Klammern weglässt (er endet in NameOfTheMethod und nicht NameOfTheMethod()).

page-type

Der page-type Schlüssel für Web/API-Methoden ist entweder web-api-instance-method (für Instanzmethoden) oder web-api-static-method (für statische Methoden).

status

Flags, die den Status dieser Funktion beschreiben. Ein Array, das einen oder mehrere der folgenden Werte 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 die Funktion gesetzt. Siehe "Wie Feature-Status hinzugefügt oder aktualisiert werden".

browser-compat

Ersetzen Sie den Platzhalterwert path.to.feature.NameOfTheMethod mit der Abfragezeichenfolge für die Methode im Browser compat data repo. Die Toolchain verwendet automatisch den Schlüssel, 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 die API-Methode in unserem Browser compat data repo erstellen/aktualisieren müssen und der Eintrag für die API Spezifikationsinformationen enthalten muss. Siehe unseren Leitfaden, wie das geht.

Makros am Seitenanfang

Eine Anzahl von Makroaufrufen erscheint am Anfang des Inhaltsbereichs (direkt unter den Seiten-Metadaten).

Diese Makros werden automatisch von der Toolchain hinzugefügt (es besteht keine Notwendigkeit, sie hinzuzufügen oder 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 Nutzung der Technologie nicht empfohlen wird.
{{Non-standard_Header}} — dies erzeugt ein Nicht-standard Banner, das anzeigt, dass das Feature kein Teil einer Spezifikation ist.

Sie sollten die folgenden Makros gemäß den Ratschlägen unten 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 ja, sollten Sie auch einen Eintrag dafür auf der Seite Funktionen, die auf sichere Kontexte beschränkt sind hinzufügen.
{{AvailableInWorkers}} — dies erzeugt eine Verfügbar in Arbeitern Notiz, die anzeigt, dass die Technologie im Arbeitskontext verfügbar ist. Wenn sie nur im Fenstermodus verfügbar ist, können Sie den Makroaufruf entfernen. Wenn sie auch im Arbeitskontext oder nur im Arbeitskontext verfügbar ist, müssen Sie möglicherweise ein Parameter aufgrund ihrer Verfügbarkeit übergeben (siehe {{AvailableInWorkers}} Makroquellcode für alle verfügbaren Werte), Sie müssen möglicherweise auch einen Eintrag dafür auf der Seite Web-APIs, die in Arbeitern verfügbar sind hinzufügen.
{{APIRef("GroupDataName")}} — dies erzeugt die linke Referenz-Sidebar, die Links zugehörig zur aktuellen Seite zeigt. Zum Beispiel hat jede Seite in der WebVR API die gleiche Sidebar, die auf die anderen Seiten in der API zeigt. Um die richtige Sidebar für Ihre API zu erzeugen, müssen Sie einen GroupData Eintrag zu unserem GitHub-Repo hinzufügen und den Namen des Eintrags in den Makroaufruf anstelle von GroupDataName einbinden. Siehe unseren Leitfaden zu API-Referenz-Sidebars für Informationen, wie das gemacht wird.
Denken Sie daran, das {{MDNSidebar}} Makro zu entfernen, wenn Sie diese Seite kopieren.

Fügen Sie Statusheader-Makros nicht manuell hinzu. Verweisen Sie auf den Abschnitt "Wie Feature-Status hinzugefügt oder aktualisiert werden", um diese Status zur Seite hinzuzufügen.

Beispiele für die Sicherer Kontext, Verfügbar in Arbeitern, Experimentell, Veraltet, und Nicht-standard Banner sind direkt nach diesem Hinweisblock gezeigt.

Denken Sie daran, diese ganze Erklärung 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 und befindet sich nicht auf dem Weg zur Standardisierung. Verwenden Sie sie nicht auf Produktionsseiten, die dem Web ausgesetzt sind: Sie funktioniert nicht für alle Benutzer. Es kann auch große Inkompatibilitäten zwischen Implementierungen geben, und das Verhalten kann sich in Zukunft ändern.

Beginnen Sie den Inhalt auf der Seite mit einem einführenden Absatz — beginnen Sie mit der Benennung der Methode, nennen Sie die Schnittstelle, zu der sie gehört, und sagen Sie, was sie macht. Dies sollte idealerweise ein oder zwei kurze Sätze sein. Sie könnten den größten Teil davon aus der Zusammenfassung der Methode auf der entsprechenden API-Referenzseite kopieren.

Syntax

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

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

Hinweis: Dieser Abschnitt ist obligatorisch. Wenn es keine Parameter gibt, setzen Sie None. anstelle der Definitionsliste.

Rückgabewert

Fügen Sie eine Beschreibung des Rückgabewerts der Methode ein, einschließlich Datentyp und was er darstellt.

Wenn die Methode nichts zurückgibt, schreiben Sie einfach "None (undefined).".

Ausnahmen

Fügen Sie eine Liste aller Ausnahmen ein, die die Methode auslösen kann. Fügen Sie einen Begriff und eine Definition für jede Ausnahme 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, den name der Ausnahme.

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

IndexSizeError DOMException: Geworfen …
InvalidNodeTypeError DOMException: Geworfen …
TypeError: Geworfen …

Beschreibung

Detaillierte Beschreibung, wie die Methode sich verhält Abschnitt weggelassen, wenn ein einleitender Absatz (oder zwei) am Anfang der Seite ausreichend ist.

Beispiele

Beachten Sie, dass wir den Plural "Beispiele" verwenden, auch wenn die Seite nur ein Beispiel enthält.

Eine beschreibende Überschrift

Jedes Beispiel muss eine H3-Überschrift haben, die das Beispiel benennt. Die Überschrift sollte beschreiben, was das Beispiel tut. Zum Beispiel, "Ein einfaches Beispiel" sagt 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 Codebeispiele einfügt für weitere Informationen.

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

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

Fügen Sie eine H3-Überschrift (###) für jedes Beispiel auf dieser Seite hinzu und dann eine abschließende H3-Überschrift (###) mit dem Text "Weitere Beispiele", unter dem 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 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:

## Beispiele

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

link1
link2
external_link (Jahr)