Plantilla de subpágina del constructor de API

Nota: Eliminar toda esta nota explicativa antes de publicar

Metadatos de la página:

Los metadatos de la parte superior de la página se utilizan para definir "metadatos de página". Los valores deben actualizarse adecuadamente para el constructor.

md
---
title: NombreDelConstructor()
slug: Web/API/NombreDeLaInterfazPadre/NombreDeLaInterfazPadre
page-type: constructor-web-api
status:
  - experimental
  - deprecated
  - non-standard
browser-compat: ruta.hacia.caracteristica.NombreDelConstructor
---
title

Título que se muestra en la parte superior de la página. Formato como NombreDeLaInterfazPadre(). Por ejemplo, el constructor Request() (en-US) tiene un título de Request().

slug

El final de la ruta de URL después de https://developer.mozilla.org/es/docs/. Esto se formateará como Web/API/NombreDeLaInterfazPadre/NombreDeLaInterfazPadre. Tenga en cuenta que el nombre de la función del constructor en el slug omite los paréntesis (termina en NombreDeLaInterfazPadre no NombreDeLaInterfazPadre()).

page-type

La clave page-type para los constructores Web/API es siempre constructor-web-api.

status

Incluir claves de estado de tecnología apropiadas: experimental, deprecated, non-standard (si no está en una pista de estándar).

browser-compat

Reemplace el valor de marcador de posición ruta.hacia.caracteristica.NombreDelConstructor con la cadena de consulta para el constructor en el repositorio de datos de compatibilidad del navegador. La cadena se utiliza automáticamente para rellenar las secciones de compatibilidad y especificaciones (reemplazando los macros {{Compat}} y {{Specifications}}).

Tenga en cuenta que es posible que primero necesite crear/actualizar una entrada para el constructor de la API en nuestro repositorio de datos de compatibilidad del navegador, y la entrada para la API deberá incluir información de especificación. Vea nuestra guía sobre cómo hacer esto.

Macros en la parte superior de la página

Aparecen varias llamadas de macro en la parte superior de la sección de contenido (inmediatamente debajo de los metadatos de la página). Debería actualizarlos o eliminarlos según el consejo a continuación:

  • {{SeeCompatTable}} — esto genera un banner Esta es una tecnología experimental que indica que la tecnología es experimental. Si la tecnología que está documentando no es experimental, debería eliminar esto. Si es experimental, y la tecnología está oculta detrás de una preferencia en Firefox, también debería completar una entrada para ella en la página Características experimentales en Firefox.
  • {{Deprecated_Header}} — esto genera un banner Desaprobado que indica que se desaconseja el uso de la tecnología desaprobada. Si no lo es, entonces puede eliminar la llamada al macro.
  • {{SecureContext_Header}} — esto genera un banner Contexto seguro que indica que la tecnología solo está disponible en un contexto seguro (en-US). Si no lo es, entonces puede eliminar la llamada al macro. Si lo es, entonces también debería completar una entrada para ella en la página Funciones restringidas a contextos seguros (en-US).
  • {{APIRef("GroupDataName")}} — esto genera un menú lateral de referencia del lado izquierdo que muestra enlaces de referencia rápida relacionados con la página actual. Por ejemplo, cada página en la WebVR API tiene el mismo menú lateral, que apunta a las otras páginas en la API. Para generar el menú lateral correcto para su API, debe agregar una entrada GroupData a nuestro repositorio de GitHub e incluir el nombre de la entrada dentro de la llamada a la macro en lugar de GroupDataName. Vea nuestra guía de menús laterales de referencia de API para obtener información sobre cómo hacerlo. Recuerde eliminar el macro {{MDNSidebar}} cuando copie esta página.

Se muestran ejemplos de los banners Experimental, Contexto seguro y Desaprobado justo después de este bloque de notas.

Recuerde eliminar toda esta nota explicativa antes de publicar.

Experimental: Esta es una tecnología experimental
Comprueba la Tabla de compabilidad de navegadores cuidadosamente antes de usarla en producción.

Contexto seguro: Esta función está disponible solo en contextos seguros (en-US) (HTTPS), en algunos o todos los navegadores que lo soportan.

Obsoleto: Esta característica ya no se recomienda. Aunque es posible que algunos navegadores aún lo admitan, probablemente ya se ha eliminado de los estándares web relevantes, está en proceso de eliminación o solo se conserva por motivos de compatibilidad. Evite usarlo y actualice el código existente si es posible; consulte la tabla de compatibilidad en la parte inferior de esta página para orientar su decisión. Tenga en cuenta que esta característica puede dejar de funcionar en cualquier momento.

Comience el contenido en la página con un párrafo introductorio — comience nombrando el constructor y diciendo qué hace. Idealmente, esto debería ser una o dos frases cortas. Podría copiar la mayor parte de esto del resumen del constructor en la página de referencia de la API correspondiente.

Sintaxis

Complete un cuadro de sintaxis, según la guía en nuestro artículo secciones de sintaxis (en-US).

Parámetros

parámetro1 Opcional

Incluya una breve descripción del parámetro y lo que hace aquí. Incluya un término y definición para cada parámetro. Si el parámetro no es opcional, elimine la llamada a la macro {{optional_inline}}.

parámetro2

etc.

Valor de retorno

Incluya una descripción del valor de retorno del constructor, incluido el tipo de dato y lo que representa. Normalmente, esto es simplemente "Una instancia del objeto {{domxref("NombreDeLaInterfazPadre")}}".

Para usar esta macro, elimine las comillas invertidas y la barra invertida en el archivo markdown.

Excepciones

Incluya una lista de todas las excepciones que puede generar el constructor. Incluya un término y definición para cada excepción.

Excepción1

Incluya descripciones de cómo se genera la excepción.

Excepción2

Incluya descripciones de cómo se genera la excepción.

Ejemplos

Un encabezado descriptivo

Cada ejemplo debe tener un encabezado H3 que nombre el ejemplo. El encabezado debe ser descriptivo de lo que hace el ejemplo. Por ejemplo, "Un ejemplo simple" no dice nada sobre el ejemplo y, por lo tanto, no es un buen encabezado. El encabezado debería ser conciso. Para una descripción más larga, use el párrafo después del encabezado.

Consulte nuestra guía sobre cómo agregar ejemplos de código para obtener más información.

Nota: A veces querrá enlazar a ejemplos dados en otra página.

Escenario 1: Si tiene algunos ejemplos en esta página y algunos más en otra página:

Incluya un encabezado H3 (###) para cada ejemplo en esta página y luego un encabezado H3 final (###) con el texto "Más ejemplos", debajo del cual puede enlazar a los ejemplos en otras páginas. Por ejemplo:

md
## Ejemplos

### Usando la API fetch

Ejemplo de Fetch

### Más ejemplos

Enlaces a más ejemplos en otras páginas

Escenario 2: Si solo tiene ejemplos en otra página y ninguno en esta página:

No agregue ningún encabezado H3; simplemente agregue los enlaces directamente debajo del encabezado H2 "Ejemplos". Por ejemplo:

md
## Ejemplos

Para ejemplos de esta API, consulte [la página sobre fetch()](https://example.org).

Especificaciones

{{Specifications}}

Para usar esta macro, elimine las comillas invertidas y la barra invertida en el archivo markdown.

Compatibilidad con navegadores

{{Compat}}

Para usar esta macro, elimine las comillas invertidas y la barra invertida en el archivo markdown.

Véase también

Incluya enlaces a páginas de referencia y guías relacionadas con la API actual. Para obtener más pautas, consulte la sección Véase también en la Guía de estilo de escritura.

  • enlace1
  • enlace2
  • enlace_externo (año)