An explicit error that can be thrown from a handler to send an error to the client that called the function.

Signature:

exportdeclareclassHttpsErrorextendsError

Extends: Error

Constructors

Properties

Methods

https.HttpsError.(constructor)

Constructs a new instance of theHttpsError class

Signature:

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

Parameters

https.HttpsError.code

A standard error code that will be returned to the client. This also determines the HTTP status code of the response, as defined in code.proto.

Signature:

readonlycode:FunctionsErrorCode;

https.HttpsError.details

Extra data to be converted to JSON and included in the error response.

Signature:

readonlydetails:unknown;

https.HttpsError.httpErrorCode

A wire format representation of a provided error code.

Signature:

readonlyhttpErrorCode:HttpErrorCode;

https.HttpsError.toJSON()

Returns a JSON-serializable representation of this object.

Signature:

toJSON():HttpErrorWireFormat;

Returns:

HttpErrorWireFormat