JavaScript class page 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 particular class.

---
title: Constructor
slug: Web/JavaScript/Reference/Global_Objects/Constructor
page-type: javascript-class
status:
  - deprecated
  - experimental
  - non-standard
browser-compat: javascript.builtins.Constructor
sidebar: jsref
---

title

Title heading displayed at the top of the page. Format as Constructor. For example, the Array class has a title of Array.

slug

The end of the URL path after https://developer.mozilla.org/en-US/docs/. This should be formatted like Web/JavaScript/Reference/Global_Objects/Constructor.

page-type

The page-type key for JavaScript classes is javascript-class.

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 feature statuses are added or updated".

browser-compat

Replace the placeholder value javascript.builtins.Constructor with the query string for the class 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 class 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.

sidebar

This is jsref for JavaScript class pages. See Page structures: Sidebars for details.

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

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

Samples of the Experimental and Non-standard banners are shown right after this note block.

Remember to remove this whole explanatory note before publishing.

Note: Remember the single most important principle for writing consistent JavaScript reference pages: look around! Many related pages have consistent structures beyond what's required in this template. For example, all proxy handlers, most array methods, etc. Start by looking for existing documentation for similar APIs and copy its structure.

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

Non-standard: This feature is not standardized. We do not recommend using non-standard features in production, as they have limited browser support, and may change or be removed. However, they can be a suitable alternative in specific cases where no standard option exists.

The Constructor object represents something. This should ideally be 1 or 2 short sentences. Generally, don't write more than a single paragraph with more than a few sentences: significant detail goes into the description.

(If applicable) Constructor is a subclass of {{jsxref("BaseConstructor")}}.

Write an interactive example that demonstrates important aspects of the class. This should be rare: usually, you would have interactive examples for the constructor and each individual method. Only write an interactive example for the class if it demonstrates the class as a whole, such as the whole CRUD workflow with a Map.

Try it

const obj = new Constructor();
console.log(obj.something);
// Expected output: 42

Description

The description for a class should contain the following:

Background information about why the API is useful
Core concepts that subpages could potentially link to
Overview of ways to interact with this API
Caveats

Use H3 headings as appropriate.

Constructor

{{jsxref("Constructor/Constructor", "Constructor()")}}: Creates a new Constructor object.

Static properties

{{jsxref("Constructor.nameOfTheProperty")}}: Contains something.

Static methods

{{jsxref("Constructor.nameOfTheMethod()")}}: Does something.

Instance properties

These properties are defined on Constructor.prototype and shared by all Constructor instances.

Constructor.prototype.constructor: The constructor function that created the instance object. For Constructor instances, the initial value is the {{jsxref("Constructor/Constructor", "Constructor")}} constructor.
{{jsxref("Constructor.prototype.nameOfTheProperty")}}: Returns something.
Constructor.prototype[Symbol.toStringTag]: The initial value of the Symbol.toStringTag property is the string "Constructor". This property is used in Object.prototype.toString().

These properties are own properties of each Constructor instance.

{{jsxref("Constructor/nameOfTheProperty", "nameOfTheProperty")}}: Contains something.

Instance methods

{{jsxref("Constructor.prototype.nameOfTheMethod()")}}: Returns something.

Examples

Note that we use the plural "Examples" even if the page only contains one example.

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. The first example may be called "Using Constructor".

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