API constructor subpage template

Note: Remove this whole explanatory note before publishing

Page front matter:

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

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

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

slug

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

page-type

The page-type key for Web/API constructors is always web-api-constructor.

status

Flags describing the status of this feature. An array which may contain one or more of the following: experimental, deprecated, non-standard. This key should not be set manually: it is set automatically based on values in the browser compatibility data for the feature. See "How to add or update feature statuses".

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 front matter).

These macros are automatically added by the toolchain (there is no need to add/remove):

  • {{SeeCompatTable}} — this generates a This is an experimental technology banner that indicates the technology is experimental. 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.
  • {{Non-standard_Header}} — this generates a Non-standard banner that indicates that the feature is not part of any specification.

You should update or delete the following macros according to the advice below:

  • {{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.
  • {{AvailableInWorkers}} — this generates a Available In Workers note that indicates that the technology is available in worker context. If it is only available in window context, then you can remove the macro call. If it is also available or only available in worker context, then you may also need to passing an parameter to it due to its availability (see {{AvailableInWorkers}} macros source code for all available values), you may also need to fill in an entry for it in the Web APIs available in workers 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.

Do not provide status header macros manually. Refer to the section How to add or update feature statuses to add these statuses to the page.

Samples of the Secure context, Available in workers, Experimental, Deprecated, and Non-standard banners are shown right after this note block.

Remember to remove this whole explanatory note before publishing.

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

Note: This feature is available in Web Workers.

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

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.

Non-standard: This feature is non-standard and is not on a standards track. Do not use it on production sites facing the Web: it will not work for every user. There may also be large incompatibilities between implementations and the behavior may change in the future.

Begin the content on the page with an introductory paragraph — start by naming the constructor and saying what it does. This should ideally be one or two 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 the data type and what it represents. This is normally just "An instance of the {{domxref("NameOfTheParentInterface")}} object."

To use this macro, remove the backticks and backslash in the markdown file.

Exceptions

Include a list of all the exceptions that the constructor can raise. Include one term and definition for each exception.

Exception1

Include descriptions of how the exception is raised.

Exception2

Include descriptions of how the exception is raised.

Note that we have two kinds of exceptions: DOMException objects and regular JavaScript exceptions, like TypeError and RangeError. A web developer needs to know:

  • which object is thrown
  • for exceptions that are DOMException objects, the name of the exception.

Here is an example where a method can raise a DOMException with a name of IndexSizeError, a second DOMException with a name of InvalidNodeTypeError and a JavaScript exception of type TypeError:

IndexSizeError DOMException

Thrown …

InvalidNodeTypeError DOMException

Thrown …

TypeError

Thrown …

Examples

A descriptive heading

Each example must have an H3 heading naming the example. The heading should be descriptive of what the example is doing. For example, "A simple example" does not say anything about the example and therefore, not a good heading. The heading should be concise. For a longer description, use the paragraph after the heading.

See our guide on how to add code examples for more information.

Note: Sometimes you will want to link to examples given on another page.

Scenario 1: If you have some examples on this page and some more examples on another page:

Include an H3 heading (###) for each example on this page and then a final H3 heading (###) with the text "More examples", under which you can link to the examples on other pages. For example:

md
## Examples

### Using the fetch API

Example of Fetch

### More examples

Links to more examples on other pages

Scenario 2: If you only have examples on another page and none on this page:

Don't add any H3 headings; just add the links directly under the H2 heading "Examples". For example:

md
## Examples

For examples of this API, see [the page on fetch()](https://example.org/).

Specifications

{{Specifications}}

To use this macro, remove the backticks and backslash in the markdown file.

Browser compatibility

{{Compat}}

To use this macro, remove the backticks and backslash in the markdown file.

See also

Include links to reference pages and guides related to the current API. For more guidelines, see the See also section in the Writing style guide.

  • link1
  • link2
  • external_link (year)