* `FirebaseError` is a subclass of the standard JavaScript `Error` object. In * addition to a message string and stack trace, it contains a string code.
| 38 | * addition to a message string and stack trace, it contains a string code. |
| 39 | */ |
| 40 | interface FirebaseError { |
| 41 | /** |
| 42 | * Error codes are strings using the following format: `"service/string-code"`. |
| 43 | * Some examples include `"app/no-app"` and `"auth/user-not-found"`. |
| 44 | * |
| 45 | * While the message for a given error can change, the code will remain the same |
| 46 | * between backward-compatible versions of the Firebase SDK. |
| 47 | */ |
| 48 | code: string; |
| 49 | /** |
| 50 | * An explanatory message for the error that just occurred. |
| 51 | * |
| 52 | * This message is designed to be helpful to you, the developer. Because |
| 53 | * it generally does not convey meaningful information to end users, |
| 54 | * this message should not be displayed in your application. |
| 55 | */ |
| 56 | message: string; |
| 57 | /** |
| 58 | * The name of the class of errors, which is `"FirebaseError"`. |
| 59 | */ |
| 60 | name: string; |
| 61 | /** |
| 62 | * A string value containing the execution backtrace when the error originally |
| 63 | * occurred. This may not always be available. |
| 64 | * |
| 65 | * When it is available, this information can be sent to |
| 66 | * {@link https://firebase.google.com/support/ Firebase Support} to help |
| 67 | * explain the cause of an error. |
| 68 | */ |
| 69 | stack?: string; |
| 70 | } |
| 71 | |
| 72 | /** |
| 73 | * @hidden |
nothing calls this directly
no outgoing calls
no test coverage detected