cloudfire-auth / FirebaseError

Interface: FirebaseError

Defined in: types/firebase-admin/index.ts:101

FirebaseError is a subclass of the standard JavaScript Error object. In addition to a message string and stack trace, it contains a string code.

Properties

code

code: string

Defined in: types/firebase-admin/index.ts:110

Error codes are strings using the following format: "service/string-code". Some examples include "auth/invalid-uid" and "messaging/invalid-recipient".

While the message for a given error can change, the code will remain the same between backward-compatible versions of the Firebase SDK.

---

message

message: string

Defined in: types/firebase-admin/index.ts:118

An explanatory message for the error that just occurred.

This message is designed to be helpful to you, the developer. Because it generally does not convey meaningful information to end users, this message should not be displayed in your application.

---

stack?

optional stack: string

Defined in: types/firebase-admin/index.ts:126

A string value containing the execution backtrace when the error originally occurred.

This information can be useful for troubleshooting the cause of the error with Firebase Support.

Methods

toJSON()

toJSON(): object

Defined in: types/firebase-admin/index.ts:132

Returns a JSON-serializable object representation of this error.

Returns

object

A JSON-serializable representation of this object.