FirebaseError interface

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

Signature:

exportinterfaceFirebaseError

Properties

PropertyTypeDescription
codestringError 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.
messagestringAn 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.
stackstringA string value containing the execution backtrace when the error originally occurred.This information can be useful for troubleshooting the cause of the error withFirebase Support.

Methods

MethodDescription
toJSON()Returns a JSON-serializable object representation of this error.

FirebaseError.code

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.

Signature:

code:string;

FirebaseError.message

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.

Signature:

message:string;

FirebaseError.stack

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

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

Signature:

stack?:string;

FirebaseError.toJSON()

Returns a JSON-serializable object representation of this error.

Signature:

toJSON():object;

Returns:

object

A JSON-serializable representation of this object.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2022-07-29 UTC.