identity.HttpsError class

Явная ошибка, которая может быть вызвана обработчиком для отправки ошибки клиенту, вызвавшему функцию.

Подпись:

export declare class HttpsError extends Error 

Расширяется: ошибка

Конструкторы

Конструктор Модификаторы Описание
(конструктор)(код, сообщение, детали) Создает новый экземпляр класса HttpsError

Характеристики

Свойство Модификаторы Тип Описание
код ФункцииErrorCode Стандартный код ошибки, который будет возвращен клиенту. Это также определяет код состояния HTTP ответа, как определено в code.proto.
подробности неизвестный Дополнительные данные, которые необходимо преобразовать в JSON и включить в ответ об ошибке.
httpErrorCode Хттперроркоде Представление предоставленного кода ошибки в проводном формате.

Методы

Метод Модификаторы Описание
toJSON() Возвращает сериализуемое в формате JSON представление этого объекта.

идентификация.HttpsError.(конструктор)

Создает новый экземпляр класса HttpsError

Подпись:

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

Параметры

Параметр Тип Описание
код ФункцииErrorCode
сообщение нить
подробности неизвестный

личность.HttpsError.code

Стандартный код ошибки, который будет возвращен клиенту. Это также определяет код состояния HTTP ответа, как определено в code.proto.

Подпись:

readonly code: FunctionsErrorCode;

личность.HttpsError.details

Дополнительные данные, которые необходимо преобразовать в JSON и включить в ответ об ошибке.

Подпись:

readonly details: unknown;

личность.HttpsError.httpErrorCode

Представление предоставленного кода ошибки в проводном формате.

Подпись:

readonly httpErrorCode: HttpErrorCode;

личность.HttpsError.toJSON()

Возвращает сериализуемое в формате JSON представление этого объекта.

Подпись:

toJSON(): HttpErrorWireFormat;

Возврат:

HttpErrorWireFormat