Um erro explícito que pode ser lançado de um manipulador para enviar um erro ao cliente que chamou a função.
Assinatura:
export declare class HttpsError extends Error
Estende: Erro
Construtores
| Construtor | Modificadores | Descrição |
|---|---|---|
| (construtor)(código, mensagem, detalhes) | Constrói uma nova instância da classe HttpsError |
Propriedades
| Propriedade | Modificadores | Tipo | Descrição |
|---|---|---|---|
| código | FunctionsErrorCode | Um código de erro padrão que será retornado ao cliente. Isso também determina o código de status HTTP da resposta, conforme definido em code.proto. | |
| detalhes | desconhecido | Dados extras a serem convertidos em JSON e incluídos na resposta de erro. | |
| httpErrorCode | HttpErrorCode | Uma representação de formato de ligação de um código de erro fornecido. |
Métodos
| Método | Modificadores | Descrição |
|---|---|---|
| toJSON() | Retorna uma representação serializável em JSON desse objeto. |
https.HttpsError.(construtor)
Constrói uma nova instância da classe HttpsError
Assinatura:
constructor(code: FunctionsErrorCode, message: string, details?: unknown);
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| código | FunctionsErrorCode | |
| mensagem | corda | |
| detalhes | desconhecido |
https.HttpsError.code
Um código de erro padrão que será retornado ao cliente. Isso também determina o código de status HTTP da resposta, conforme definido em code.proto.
Assinatura:
readonly code: FunctionsErrorCode;
https.HttpsError.details
Dados extras a serem convertidos em JSON e incluídos na resposta de erro.
Assinatura:
readonly details: unknown;
https.HttpsError.httpErrorCode
Uma representação de formato de ligação de um código de erro fornecido.
Assinatura:
readonly httpErrorCode: HttpErrorCode;
https.HttpsError.toJSON()
Retorna uma representação serializável em JSON desse objeto.
Assinatura:
toJSON(): HttpErrorWireFormat;
Retorna:
HttpErrorWireFormat