auth.HttpsError class

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

Firma:

export declare class HttpsError extends Error 

Extiende: Error

Constructores

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

Propiedades

Propiedad Teclas modificadoras Tipo Descripción
código FunctionsErrorCode Un código de error estándar que se mostrará 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.
httpErrorCode. HttpErrorCode Una representación en formato de cable de un código de error proporcionado.

Métodos

Método Teclas modificadoras Descripción
toJSON() Muestra una representación JSON serializable de este objeto.

auth.HttpsError.(constructor)

Construye una instancia nueva de la clase HttpsError.

Firma:

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

Parámetros

Parámetro Tipo Descripción
código FunctionsErrorCode
mensaje string
detalles desconocido

auth.HttpsError.code

Un código de error estándar que se mostrará 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.details

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()

Muestra una representación JSON serializable de este objeto.

Firma:

toJSON(): HttpErrorWireFormat;

Muestra:

HttpErrorWireFormat