API constructor subpage template

Note: Remove this whole explanatory note before publishing


Page front matter:

The frontmatter at the top of the page is used to define "page metadata". The values should be updated appropriately for the constructor.

---
title: NameOfTheConstructor()
slug: Web/API/NameOfTheParentInterface/NameOfTheParentInterface
tags:
  - API
  - Constructor
  - Reference
  - Experimental
  - Deprecated
  - Non-standard
browser-compat: path.to.feature.NameOfTheConstructor
---
title

Title heading displayed at top of page. Format as NameOfTheParentInterface(). For example, the Request() constructor has a title of Request().

slug

The end of the URL path after https://developer.mozilla.org/en-US/docs/). This will be formatted like Web/API/NameOfTheParentInterface/NameOfTheParentInterface. Note that the name of the constructor function in the slug omits the parenthesis (it ends in NameOfTheParentInterface not NameOfTheParentInterface()).

tags

Always include the following tags: API, Reference, Constructor, the name of the API (e.g. WebVR), the name of the parent interface (e.g. IDBIndex).

Include the following tags as appropriate:

  • Technology status: Experimental (if the technology is experimental), Deprecated (if it is deprecated), Non-standard if it isn't on a standards track.
  • Special requirements: Secure context (if it is available in a secure context only)
  • Any other tags that represent terms people might search for related to the technology. For example on WebVR interface pages we include VR and Virtual reality.
browser-compat

Replace the placeholder value path.to.feature.NameOfTheConstructor with the query string for the constructor in the Browser compat data repo. The toolchain automatically uses the key to populate the compatibility and specification sections (replacing the {{Compat}} and {{Specifications}} macros).

Note that you may first need to create/update an entry for the API constructor in our Browser compat data repo, and the entry for the API will need to include specification information. See our guide on how to do this.


Top-of-page macros

A number of macro calls appear at the top of the content section (immediately below the page frontmatter). You should update or delete them according to the advice below:

  • {{SeeCompatTable}} — this generates a This is an experimental technology banner that indicates the technology is experimental). If the technology you are documenting is not experimental, you should remove this. If it is experimental, and the technology is hidden behind a pref in Firefox, you should also fill in an entry for it in the Experimental features in Firefox page.
  • {{Deprecated_Header}} — this generates a Deprecated banner that indicates that use of the technology is discouraged. If it isn't, then you can remove the macro call.
  • {{SecureContext_Header}} — this generates a Secure context banner that indicates the technology is only available in a secure context. If it isn't, then you can remove the macro call. If it is, then you should also fill in an entry for it in the Features restricted to secure contexts page.
  • {{APIRef("GroupDataName")}} — this generates the left hand reference sidebar showing quick reference links related to the current page. For example, every page in the WebVR API has the same sidebar, which points to the other pages in the API. To generate the correct sidebar for your API, you need to add a GroupData entry to our GitHub repo, and include the entry's name inside the macro call in place of GroupDataName. See our API reference sidebars guide for information on how to do this.
  • Remember to remove the {{MDNSidebar}} macro when you copy this page.

Remember to remove this whole explanatory note before publishing

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

Deprecated: This feature is no longer recommended. Though some browsers might still support it, it may have already been removed from the relevant web standards, may be in the process of being dropped, or may only be kept for compatibility purposes. Avoid using it, and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.

The summary paragraph — start by naming the constructor, and saying what it does. This should ideally be 1 or 2 short sentences. You could copy most of this from the constructor's summary on the corresponding API reference page.

Syntax

Fill in a syntax box, according to the guidance in our syntax sections article.

Parameters

parameter1 Optional

Include a brief description of the parameter and what it does here. Include one term and definition for each parameter. If the parameter is not optional, remove the {{optional_inline}} macro call.

parameter2

etc.

Return value

Include a description of the constructor's return value, including data type and what it represents. This is normally just "An instance of the NameOfTheParentInterface object."

Exceptions

Exception1

Include a list of all the exceptions that the constructor can raise, along with descriptions of how that exception is raised. Include one term and definition for each exception.

Exception2

etc.

Examples

Fill in a simple example that nicely shows a typical usage of the constructor, then perhaps some more complex examples (see our guide on how to add code examples for more information).

my code block

And/or include a list of links to useful code samples that live elsewhere:

  • x
  • y
  • z

Specifications

No specification found

No specification data found for path.to.feature.NameOfTheConstructor.
Check for problems with this page or contribute a missing spec_url to mdn/browser-compat-data. Also make sure the specification is included in w3c/browser-specs.

Browser compatibility

No compatibility data found for path.to.feature.NameOfTheConstructor.
Check for problems with this page or contribute missing data to mdn/browser-compat-data.

See also

  • Include list of
  • other links related to
  • this API that might be useful