auth.HttpsError class

Un error explícito que puede generar un controlador para enviar un error al cliente que llamó a la función.

Firma:

export declare class HttpsError extends Error 

Se extiende: Error

Constructores

Constructor Modificadores Descripción
(constructor)(código, mensaje, detalles) Construye una nueva instancia de la clase HttpsError

Propiedades

Propiedad Modificadores Tipo Descripción
código FuncionesCódigo de error Un código de error estándar que será devuelto al cliente. Esto también determina el código de estado HTTP de la respuesta, como se define en code.proto.
detalles desconocido Datos adicionales que se convertirán a JSON y se incluirán en la respuesta de error.
httpCódigo de error Código de error HTTP Una representación en formato de cable de un código de error proporcionado.

Métodos

Método Modificadores Descripción
a JSON() Devuelve una representación serializable JSON de este objeto.

auth.HttpsError.(constructor)

Construye una nueva instancia de la clase HttpsError

Firma:

constructor(code: FunctionsErrorCode, message: string, details?: unknown);

Parámetros

Parámetro Tipo Descripción
código FuncionesCódigo de error
mensaje cadena
detalles desconocido

auth.HttpsError.código

Un código de error estándar que será devuelto al cliente. Esto también determina el código de estado HTTP de la respuesta, como se define en code.proto.

Firma:

readonly code: FunctionsErrorCode;

auth.HttpsError.detalles

Datos adicionales que se convertirán a JSON y se incluirán en la respuesta de error.

Firma:

readonly details: unknown;

auth.HttpsError.httpErrorCode

Una representación en formato de cable de un código de error proporcionado.

Firma:

readonly httpErrorCode: HttpErrorCode;

auth.HttpsError.toJSON()

Devuelve una representación serializable JSON de este objeto.

Firma:

toJSON(): HttpErrorWireFormat;

Devoluciones:

HttpErrorWireFormato