mirror of
https://github.com/hanzoai/firebase-js-sdk.git
synced 2026-09-24 16:59:10 +00:00
ae8a1b0432
* Remove FunctionsError interface * Make FunctionsError class public * Add changeset * Add instanceof check in tests * Make FunctionsError doc comment the same as the old interface * Update devsite docs * Add period to constructor doc comment * Formatting * Update API reports * update docs --------- Co-authored-by: dlarocque <[email protected]>
1.7 KiB
1.7 KiB
Project: /docs/reference/js/_project.yaml Book: /docs/reference/_book.yaml page_type: reference
{% comment %} DO NOT EDIT THIS FILE! This is generated by the JS SDK team, and any local changes will be overwritten. Changes should be made in the source code at https://github.com/firebase/firebase-js-sdk {% endcomment %}
FunctionsError class
An error returned by the Firebase Functions client SDK.
See FunctionsErrorCode for full documentation of codes.
Signature:
export declare class FunctionsError extends FirebaseError
Extends: FirebaseError
Constructors
| Constructor | Modifiers | Description |
|---|---|---|
| (constructor)(code, message, details) | Constructs a new instance of the FunctionsError class. |
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| details | unknown | Additional details to be converted to JSON and included in the error response. |
FunctionsError.(constructor)
Constructs a new instance of the FunctionsError class.
Signature:
constructor(
code: FunctionsErrorCode, message?: string,
details?: unknown);
Parameters
| Parameter | Type | Description |
|---|---|---|
| code | FunctionsErrorCode | |
| message | string | |
| details | unknown |
FunctionsError.details
Additional details to be converted to JSON and included in the error response.
Signature:
readonly details?: unknown;