Un error explícito que se puede generar desde 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 | modificadores | Descripción |
|---|---|---|
| (constructor)(código, mensaje, detalles) | Construye una nueva instancia de la clase HttpsError |
Propiedades
| Propiedad | modificadores | Tipo | Descripción |
|---|---|---|---|
| código | FunctionsErrorCode | Un código de error estándar que se devolverá 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 para convertir a JSON e incluir 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 | Modificadores | Descripción |
|---|---|---|
| aJSON() | Devuelve una representación JSON serializable de este objeto. |
https.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 | FunctionsErrorCode | |
| mensaje | cadena | |
| detalles | desconocido |
https.HttpsError.código
Un código de error estándar que se devolverá 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;
https.HttpsError.detalles
Datos adicionales para convertir a JSON e incluir en la respuesta de error.
Firma:
readonly details: unknown;
https.HttpsError.httpErrorCode
Una representación en formato de cable de un código de error proporcionado.
Firma:
readonly httpErrorCode: HttpErrorCode;
https.HttpsError.toJSON()
Devuelve una representación JSON serializable de este objeto.
Firma:
toJSON(): HttpErrorWireFormat;
Devoluciones:
HttpErrorWireFormat