https.HttpsError class

Um erro explícito que pode ser gerado por 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 FunçõesErrorCode 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 para JSON e incluídos na resposta de erro.
httpErrorCode CódigoHttpError Uma representação em formato de ligação de um código de erro fornecido.

Métodos

Método Modificadores Descrição
paraJSON() Retorna uma representação serializável JSON deste 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 FunçõesErrorCode
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 para JSON e incluídos na resposta de erro.

Assinatura:

readonly details: unknown;

https.HttpsError.httpErrorCode

Uma representação em formato de ligação de um código de erro fornecido.

Assinatura:

readonly httpErrorCode: HttpErrorCode;

https.HttpsError.toJSON()

Retorna uma representação serializável JSON deste objeto.

Assinatura:

toJSON(): HttpErrorWireFormat;

Retorna:

HttpErrorWireFormat