Um erro explícito que pode ser gerado a partir 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) | Cria uma nova instância da classe HttpsError |
Propriedades
| Propriedade | Modificadores | Tipo | Descrição |
|---|---|---|---|
| código | FunctionsErrorCode (em inglês) | 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 no code.proto. | |
| detalhes | desconhecido | Dados extras a serem convertidos para JSON e incluídos na resposta de erro. | |
| httpErrorCode (em inglês) | Código HTTPErro | Uma representação de formato eletrônico de um código de erro fornecido. |
Métodos
| Método | Modificadores | Descrição |
|---|---|---|
| toJSON() (link em inglês) | Retorna uma representação serializável do JSON desse objeto. |
https.HttpsError.(construtor)
Cria 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 (link em inglês) | |
| mensagem | string | |
| 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 no code.proto.
Assinatura:
readonly code: FunctionsErrorCode;
https.HttpsError.details
Dados extras a serem convertidos para JSON e incluídos na resposta de erro.
Assinatura:
readonly details: unknown;
https.HttpsError.httpErrorCode
Uma representação de formato eletrônico de um código de erro fornecido.
Assinatura:
readonly httpErrorCode: HttpErrorCode;
https.HttpsError.toJSON()
Retorna uma representação serializável do JSON desse objeto.
Assinatura:
toJSON(): HttpErrorWireFormat;
Retorna:
HttpErrorWireFormat